tropo_rest 0.0.1

data/spec/tropo_rest/client/application_spec.rb

@@ -0,0 +1,210 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe TropoRest::Client do
+
+  before do
+    @client = TropoRest::Client.new
+  end
+
+  describe "#applications" do
+
+    before do
+      stub_get("applications").to_return(:body => <<-JSON
+        [
+          {
+            "id": "1",
+            "href": "https://api.tropo.com/v1/applications/1",
+            "name": "app1",
+            "platform": "scripting",
+            "voiceUrl": "http://example1.com/voice.rb",
+            "messagingUrl": "http://example1.com/messaging.rb",
+            "partition": "staging"
+          },
+          {
+            "id": "2",
+            "href": "https://api.tropo.com/v1/applications/2",
+            "name": "app2",
+            "platform": "webapi",
+            "voiceUrl": "http://example2.com/voice",
+            "messagingUrl": "http://example2.com/messaging",
+            "partition": "production"
+          }
+        ]
+        JSON
+      )
+    end
+
+    it "should make the request" do
+      @client.applications
+      a_get("applications").should have_been_made
+    end
+
+    it "should return a collection of applications" do
+      @client.applications.should have(2).items
+    end
+
+    it "should return the correct objects" do
+      apps  = @client.applications
+      first = apps.first
+      last  = apps.last
+
+      first.should be_instance_of(TropoRest::Resource::Application)
+      first.id.should             == "1"
+      first.href.should           == "https://api.tropo.com/v1/applications/1"
+      first.name.should           == "app1"
+      first.platform.should       == "scripting"
+      first.voice_url.should      == "http://example1.com/voice.rb"
+      first.messaging_url.should  == "http://example1.com/messaging.rb"
+      first.partition.should      == "staging"
+
+      last.should be_instance_of(TropoRest::Resource::Application)
+      last.id.should              == "2"
+      last.href.should            == "https://api.tropo.com/v1/applications/2"
+      last.name.should            == "app2"
+      last.platform.should        == "webapi"
+      last.voice_url.should       == "http://example2.com/voice"
+      last.messaging_url.should   == "http://example2.com/messaging"
+      last.partition.should       == "production"
+    end
+
+  end
+
+  describe "#application" do
+
+    before do
+      stub_get("applications/1").to_return(:body => <<-JSON
+        {
+          "id": "1",
+          "href": "https://api.tropo.com/v1/applications/1",
+          "name": "app1",
+          "platform": "scripting",
+          "voiceUrl": "http://example1.com/voice.rb",
+          "messagingUrl": "http://example1.com/messaging.rb",
+          "partition": "staging"
+        }
+        JSON
+      )
+    end
+
+    it "should make the request with an application ID" do
+      @client.application(1)
+      a_get("applications/1").should have_been_made
+    end
+
+    it "should make the request with an application HREF" do
+      @client.application("https://api.tropo.com/v1/applications/1")
+      a_get("applications/1").should have_been_made
+    end
+
+    it "should return an application object" do
+      app = @client.application(1)
+      app.should be_instance_of(TropoRest::Resource::Application)
+      app.id.should             == "1"
+      app.href.should           == "https://api.tropo.com/v1/applications/1"
+      app.name.should           == "app1"
+      app.platform.should       == "scripting"
+      app.voice_url.should      == "http://example1.com/voice.rb"
+      app.messaging_url.should  == "http://example1.com/messaging.rb"
+      app.partition.should      == "staging"
+    end
+
+  end
+
+  describe "#create_application" do
+
+    before do
+      @underscore = {
+        :name => "new app",
+        :voice_url => "http://website.com",
+        :messaging_url => "http://website2.com",
+        :platform => "scripting",
+        :partition => "staging"
+      }
+      @camel_case = {
+        'name' => "new app",
+        'voiceUrl' => "http://website.com",
+        'messagingUrl' => "http://website2.com",
+        'platform' => "scripting",
+        'partition' => "staging"
+      }
+      stub_post("applications").
+        with(:body => @camel_case).
+        to_return(:body => %({"href":"https://api.tropo.com/v1/applications/123456"}))
+    end
+
+    it "should make the request" do
+      @client.create_application(@underscore)
+      a_post("applications").with(:body => @camel_case).should have_been_made
+    end
+
+    it "should return the href of the application" do
+      res = @client.create_application(@underscore)
+      res.href.should == "https://api.tropo.com/v1/applications/123456"
+    end
+
+  end
+
+  describe "#delete_application" do
+
+    before do
+      stub_delete("applications/123456").
+        to_return(:body => %({"message": "delete successful"}))
+    end
+
+    it "should make the request with an application ID" do
+      @client.delete_application(123456)
+      a_delete("applications/123456").should have_been_made
+    end
+
+    it "should make the request with an application HREF" do
+      @client.delete_application("https://api.tropo.com/v1/applications/123456")
+      a_delete("applications/123456").should have_been_made
+    end
+
+    it "should return a successful message" do
+      res = @client.delete_application(123456)
+      res.message.should == "delete successful"
+    end
+
+  end
+
+  describe "#update_application" do
+
+    before do
+      @underscore = {
+        :name => "newer app",
+        :voice_url => "http://voice.com",
+        :messaging_url => "http://messaging.com",
+        :platform => "webapi",
+        :partition => "production"
+      }
+      @camel_case = {
+        'name' => "newer app",
+        'voiceUrl' => "http://voice.com",
+        'messagingUrl' => "http://messaging.com",
+        'platform' => "webapi",
+        'partition' => "production"
+      }
+      stub_put("applications/123456").
+        with(:body => @camel_case).
+        to_return(:body => %({"href":"https://api.tropo.com/v1/applications/123456"}))
+    end
+
+    it "should make the request with an application ID" do
+      @client.update_application(123456, @underscore)
+      a_put("applications/123456").with(:body => @camel_case).should have_been_made
+    end
+
+    it "should make the request with an application HREF" do
+      @client.update_application("https://api.tropo.com/v1/applications/123456", @underscore)
+      a_put("applications/123456").with(:body => @camel_case).should have_been_made
+    end
+
+    it "should return the href of the application" do
+      res = @client.update_application(123456, @underscore)
+      res.href.should == "https://api.tropo.com/v1/applications/123456"
+    end
+
+  end
+
+end

data/spec/tropo_rest/client/exchange_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe TropoRest::Client do
+
+  before do
+    @client = TropoRest::Client.new
+  end
+
+  describe "#exchanges" do
+
+    before do
+      stub_get("exchanges").to_return(:body => <<-JSON
+        [
+          {
+            "prefix": "1321",
+            "city": "Orlando",
+            "state": "FL",
+            "country": "United States",
+            "description": "Phone Number w/ SMS"
+          },
+          {
+            "prefix": "1888",
+            "country": "United States",
+            "description": "Toll Free Phone Number"
+          },
+          {
+            "prefix": "31",
+            "country": "Netherlands",
+            "description": "International Phone Number"
+          }
+        ]
+        JSON
+      )
+    end
+
+    it "should make the request" do
+      @client.exchanges
+      a_get("exchanges").should have_been_made
+    end
+
+    it "should return a collection of exchanges" do
+      @client.exchanges.should have(3).items
+    end
+
+    it "should return the correct objects" do
+      apps    = @client.exchanges
+      first   = apps[0]
+      second  = apps[1]
+      third   = apps[2]
+
+      first.should be_instance_of(TropoRest::Resource::Exchange)
+      first.prefix.should        == "1321"
+      first.city.should          == "Orlando"
+      first.state.should         == "FL"
+      first.country.should       == "United States"
+      first.description.should   == "Phone Number w/ SMS"
+
+      second.should be_instance_of(TropoRest::Resource::Exchange)
+      second.prefix.should       == "1888"
+      second.country.should      == "United States"
+      second.description.should  == "Toll Free Phone Number"
+
+      third.should be_instance_of(TropoRest::Resource::Exchange)
+      third.prefix.should        == "31"
+      third.country.should       == "Netherlands"
+      third.description.should   == "International Phone Number"
+    end
+
+  end
+
+end

data/spec/tropo_rest/client/session_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe TropoRest::Client do
+
+  before do
+    @client = TropoRest::Client.new
+  end
+
+  describe "#create_session" do
+
+    before do
+      @params = {'token' => 'TOKEN', 'action' => 'create'}
+      stub_session_get("sessions").
+        with(:query => @params).
+        to_return(:body => <<-XML
+        <session>
+            <success>true</success>
+            <token>TOKEN</token>
+        </session>
+        XML
+      )
+    end
+
+    it "should make the request" do
+      @client.create_session("TOKEN")
+      a_session_get("sessions").
+        with(:query => @params).should have_been_made
+    end
+
+    it "should make the request with parameters" do
+      params  = {'phone_number' => '+19995551234', 'name' => 'Billy Gnosis'}
+      query   = params.merge('action' => 'create', 'token' => 'TOKEN')
+      stub_session_get("sessions").
+        with(:query => query)
+      @client.create_session("TOKEN", params)
+      a_session_get("sessions").
+        with(:query => query).should have_been_made
+    end
+
+    it "should return the session object" do
+      res = @client.create_session("TOKEN")
+      res.session.should == {'success' => 'true', 'token' => 'TOKEN'}
+    end
+
+  end
+
+end

data/spec/tropo_rest/client/signal_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe TropoRest::Client do
+
+  before do
+    @client = TropoRest::Client.new
+  end
+
+  describe "#create_signal" do
+
+    before do
+      @params = {'signal' => 'exit'}
+      stub_session_post("sessions/644a27c6da7e505ab432325056671535/signals").
+        with(:body => @params).
+        to_return(:body => <<-JSON
+          {"status": "QUEUED"}
+        JSON
+      )
+    end
+
+    it "should make the request" do
+      @client.create_signal("644a27c6da7e505ab432325056671535", "exit")
+      a_session_post("sessions/644a27c6da7e505ab432325056671535/signals").
+        with(:body => @params).should have_been_made
+    end
+
+    it "should return the signal object" do
+      res = @client.create_signal("644a27c6da7e505ab432325056671535", "exit")
+      res.status.should == "QUEUED"
+    end
+
+  end
+
+end

data/spec/tropo_rest/client_spec.rb

@@ -0,0 +1,246 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe TropoRest::Client do
+
+  describe "configuration" do
+
+    before do
+      TropoRest.reset
+    end
+
+    it "uses defaults set on TropoRest" do
+      TropoRest.configure do |config|
+        config.username         = "username"
+        config.password         = "password"
+        config.adapter          = :em_synchrony
+        config.endpoint         = "http://api.tropo.com/v1/"
+        config.session_endpoint = "http://api.tropo.com/1.0/"
+        config.user_agent       = "RSpec"
+      end
+      client = TropoRest::Client.new
+      client.username.should          == "username"
+      client.password.should          == "password"
+      client.adapter.should           == :em_synchrony
+      client.endpoint.should          == "http://api.tropo.com/v1/"
+      client.session_endpoint.should  == "http://api.tropo.com/1.0/"
+      client.user_agent.should        == "RSpec"
+    end
+
+    it "can be initialized with options hash" do
+      client = TropoRest::Client.new \
+        :username =>          "username",
+        :password =>          "password",
+        :adapter =>           :em_synchrony,
+        :endpoint =>          "http://api.tropo.com/v1/",
+        :session_endpoint =>  "http://api.tropo.com/1.0/",
+        :user_agent =>        "RSpec"
+      client.username.should          == "username"
+      client.password.should          == "password"
+      client.adapter.should           == :em_synchrony
+      client.endpoint.should          == "http://api.tropo.com/v1/"
+      client.session_endpoint.should  == "http://api.tropo.com/1.0/"
+      client.user_agent.should        == "RSpec"
+    end
+
+    it "should have sensible defaults" do
+      client = TropoRest::Client.new
+      client.username.should          be_nil
+      client.password.should          be_nil
+      client.adapter.should           == Faraday.default_adapter
+      client.endpoint.should          == "https://api.tropo.com/v1/"
+      client.session_endpoint.should  == "https://api.tropo.com/1.0/"
+      client.user_agent.should        == "TropoRest Ruby Gem #{TropoRest::VERSION}"
+    end
+
+  end
+
+  describe "request" do
+
+    before do
+      @client = TropoRest::Client.new
+    end
+
+    it "should respond to GET" do
+      @client.should respond_to(:get)
+    end
+
+    it "should perform GET" do
+      stub_get("somewhere")
+      @client.get("somewhere")
+      a_get("somewhere").should have_been_made
+    end
+
+    it "should respond to POST" do
+      @client.should respond_to(:post)
+    end
+
+    it "should perform POST" do
+      stub_post("somewhere")
+      @client.post("somewhere", {:foo => "bar"})
+      a_post("somewhere").with(:body => {:foo => "bar"}).should have_been_made
+    end
+
+    it "should respond to PUT" do
+      @client.should respond_to(:put)
+    end
+
+    it "should perform PUT" do
+      stub_put("somewhere")
+      @client.put("somewhere", {:foo => "bar"})
+      a_put("somewhere").with(:body => {:foo => "bar"}).should have_been_made
+    end
+
+    it "should respond to DELETE" do
+      @client.should respond_to(:delete)
+    end
+
+    it "should perform DELETE" do
+      stub_delete("somewhere")
+      @client.delete("somewhere")
+      a_delete("somewhere").should have_been_made
+    end
+
+    it "should use authenticated URL" do
+      stub_request(:get, "https://username:password@api.tropo.com/v1/somewhere")
+      client = TropoRest::Client.new :username => "username", :password => "password"
+      client.get("somewhere")
+      a_request(:get, "https://username:password@api.tropo.com/v1/somewhere").should have_been_made
+    end
+
+    it "should send the correct User-Agent" do
+      stub_get("somewhere")
+      @client.get("somewhere")
+      a_get("somewhere").with(:headers => {"User-Agent" => @client.user_agent}).should have_been_made
+    end
+
+    context "sessions" do
+
+      it "should use the session URL if the path passed in starts with 'sessions'" do
+        stub_request(:get, "https://api.tropo.com/1.0/sessions")
+        @client.get("sessions")
+        a_request(:get, "https://api.tropo.com/1.0/sessions").should have_been_made
+      end
+
+      it "should send XML Accept header for session requests" do
+        params = {'action' => 'create', 'token' => 'TOKEN'}
+        stub_session_get("sessions").with(:query => params)
+        @client.get("sessions", params)
+        a_session_get("sessions").with(:query => params, :headers => {"Accept" => "application/xml"}).should have_been_made
+      end
+
+      context "signals" do
+
+        it "should send JSON Accept header" do
+          params = {"signal" => "exit"}
+          stub_session_post("sessions/abcd/signals").with(:body => params)
+          @client.post("sessions/abcd/signals", params)
+          a_session_post("sessions/abcd/signals").with(:body => params, :headers => {"Accept" => "application/json"}).should have_been_made
+        end
+
+      end
+
+    end
+
+    it "should send JSON Accept header" do
+      stub_get("somewhere")
+      @client.get("somewhere")
+      a_get("somewhere").with(:headers => {"Accept" => "application/json"}).should have_been_made
+    end
+
+    it "should send JSON Content-Type header" do
+      stub_get("somewhere")
+      @client.get("somewhere")
+      a_get("somewhere").with(:headers => {"Content-Type" => "application/json"}).should have_been_made
+    end
+
+    it "should use JSON encoded requests" do
+      params = {'hello' => 'world', 'array' => [1, 2, 3]}
+      stub_post("somewhere")
+      @client.post("somewhere", params)
+      a_post("somewhere").with(:body => params).should have_been_made
+    end
+
+    it "should decode JSON responses" do
+      params = {'hello' => 'world', 'array' => [1, 2, 3]}
+      body   = MultiJson.encode(params)
+      stub_get("somewhere").to_return(:body => body)
+      res = @client.get("somewhere")
+      res.should == params
+    end
+
+    context "underscore and camel case" do
+
+      before do
+        class TestResource < Hashie::Twash
+          property :voice_url, :from => :voiceUrl
+          property :messaging_url, :from => :messagingUrl
+        end
+        @underscore = {'voice_url' => 'http://example.com', 'messaging_url' => 'http://example2.com'}
+        @camel_case = {'voiceUrl' => 'http://example.com', 'messagingUrl' => 'http://example2.com'}
+      end
+
+      it "should convert request params to camel case" do
+        stub_post("somewhere")
+        @client.post("somewhere", TestResource.new(@underscore))
+        a_post("somewhere").with(:body => @camel_case).should have_been_made
+      end
+
+      it "should convert response params to underscore" do
+        stub_get("somewhere").to_return(:body => MultiJson.encode(@camel_case))
+        res = @client.get("somewhere", TestResource)
+        res.should == @underscore
+      end
+
+    end
+
+  end
+
+  describe "errors" do
+
+    before do
+      @client = TropoRest::Client.new
+    end
+
+    it "should raise Bad Request on 400 status code" do
+      stub_get("error").to_return(:status => 400)
+      lambda { @client.get("error") }.should raise_error(TropoRest::BadRequest)
+    end
+
+    it "should raise Not Authorized on 401 status code" do
+      stub_get("error").to_return(:status => 401)
+      lambda { @client.get("error") }.should raise_error(TropoRest::NotAuthorized)
+    end
+
+    it "should raise Access Denied on 403 status code" do
+      stub_get("error").to_return(:status => 403)
+      lambda { @client.get("error") }.should raise_error(TropoRest::AccessDenied)
+    end
+
+    it "should raise Not Found on 404 status code" do
+      stub_get("error").to_return(:status => 404)
+      lambda { @client.get("error") }.should raise_error(TropoRest::NotFound)
+    end
+
+    it "should raise Method Not Allowed on 405 status code" do
+      stub_get("error").to_return(:status => 405)
+      lambda { @client.get("error") }.should raise_error(TropoRest::MethodNotAllowed)
+    end
+
+    it "should raise Unsupported Media Type on 415 status code" do
+      stub_get("error").to_return(:status => 415)
+      lambda { @client.get("error") }.should raise_error(TropoRest::UnsupportedMediaType)
+    end
+
+    it "should raise Internal Server Error on 500 status code" do
+      stub_get("error").to_return(:status => 500)
+      lambda { @client.get("error") }.should raise_error(TropoRest::InternalServerError)
+    end
+
+    it "should raise Service Unavailable on 503 status code" do
+      stub_get("error").to_return(:status => 503)
+      lambda { @client.get("error") }.should raise_error(TropoRest::ServiceUnavailable)
+    end
+
+  end
+
+end

data/spec/tropo_rest/resource/address_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe TropoRest::Resource::Address do
+
+  it { should be_kind_of(Hashie::Twash) }
+
+  %w[href type prefix number address city state channel username password token application_id].each do |param|
+    it { should respond_to(param) }
+    it { should respond_to("#{param}=") }
+  end
+
+end

data/spec/tropo_rest/resource/application_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe TropoRest::Resource::Application do
+
+  it { should be_kind_of(Hashie::Twash) }
+
+  %w[id href name voice_url messaging_url platform partition].each do |param|
+    it { should respond_to(param) }
+    it { should respond_to("#{param}=") }
+  end
+
+end

data/spec/tropo_rest/resource/exchange_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe TropoRest::Resource::Exchange do
+
+  it { should be_kind_of(Hashie::Twash) }
+
+  %w[prefix city state country description].each do |param|
+    it { should respond_to(param) }
+    it { should respond_to("#{param}=") }
+  end
+
+end

data/spec/tropo_rest_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe TropoRest do
+
+  describe ".client" do
+
+    it "should be a TropoRest::Client" do
+      TropoRest.client.should be_kind_of(TropoRest::Client)
+    end
+
+  end
+
+  it "should delegate methods to the client" do
+    client = double("TropoRest::Client")
+    client.stub(:client_method)
+    TropoRest.stub(:client).and_return(client)
+
+    client.should_receive(:client_method)
+    TropoRest.client_method
+  end
+
+end