tropo_rest 0.0.1

data/lib/tropo_rest/configuration.rb

@@ -0,0 +1,61 @@
+require 'faraday'
+
+module TropoRest
+  # Defines constants and methods related to configuration
+  module Configuration
+    VALID_OPTIONS_KEYS = [:username, :password, :adapter, :endpoint, :session_endpoint, :user_agent].freeze
+
+    # By default, don't set a username
+    DEFAULT_USERNAME = nil.freeze
+
+    # By default, don't set a password
+    DEFAULT_PASSWORD = nil.freeze
+
+    # The faraday adapter that will be used to connect if none is set
+    DEFAULT_ADAPTER = Faraday.default_adapter.freeze
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note You shouldn't set this unless you don't want to use SSL.
+    DEFAULT_ENDPOINT = 'https://api.tropo.com/v1/'.freeze
+
+    # The endpoint that will be used for the creating sessions and sending signals
+    #
+    # @note You shouldn't set this unless you don't want to use SSL.
+    DEFAULT_SESSION_ENDPOINT = 'https://api.tropo.com/1.0/'.freeze
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "TropoRest Ruby Gem #{TropoRest::VERSION}".freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.username           = DEFAULT_USERNAME
+      self.password           = DEFAULT_PASSWORD
+      self.adapter            = DEFAULT_ADAPTER
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.session_endpoint   = DEFAULT_SESSION_ENDPOINT
+      self.user_agent         = DEFAULT_USER_AGENT
+      self
+    end
+  end
+end

data/lib/tropo_rest/connection.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/request/serialize_json'
+require 'faraday/response/resource'
+require 'faraday/response/raise_http_errors'
+
+module TropoRest
+  module Connection
+    private
+
+    def connection(url, format, resource)
+      options = {
+        :headers => {'Accept' => "application/#{format}", 'User-Agent' => user_agent},
+        :url => url
+      }
+
+      Faraday::Connection.new(options) do |connection|
+        connection.use Faraday::Request::SerializeJson if format.to_sym == :json
+        connection.adapter(adapter)
+        connection.basic_auth(username, password)
+        connection.use Faraday::Response::ParseJson if format.to_sym == :json
+        connection.use Faraday::Response::ParseXml if format.to_sym == :xml
+        connection.use Faraday::Response::Resource, resource
+        connection.use Faraday::Response::RaiseHttpErrors
+      end
+    end
+  end
+end

data/lib/tropo_rest/error.rb

@@ -0,0 +1,33 @@
+module TropoRest
+  # Custom error class for rescuing from all TropoRest errors
+  #
+  # @see https://www.tropo.com/docs/rest/response_codes.htm
+  class Error < StandardError; end
+
+  # Raised when Tropo returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Tropo returns the HTTP status code 401
+  class NotAuthorized < Error; end
+
+  # Raised when Tropo returns the HTTP status code 403
+  class AccessDenied < Error; end
+
+  # Raised when Tropo returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Tropo returns the HTTP status code 405
+  class MethodNotAllowed < Error; end
+
+  # Raised when Tropo returns the HTTP status code 415
+  class UnsupportedMediaType < Error; end
+
+  # Raised when Tropo returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Tropo returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raise when you pass invalid arguments to client methods
+  class ArgumentError < ArgumentError; end
+end

data/lib/tropo_rest/request.rb

@@ -0,0 +1,66 @@
+module TropoRest
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(*args)
+      request(:get, *args)
+    end
+
+    # Perform an HTTP POST request
+    def post(*args)
+      request(:post, *args)
+    end
+
+    # Perform an HTTP PUT request
+    def put(*args)
+      request(:put, *args)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(*args)
+      request(:delete, *args)
+    end
+
+  private
+
+    def extract_request_args!(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      path, resource = args
+      resource ||= Hashie::Mash
+      [path, resource, options]
+    end
+
+    # if a user passes in an HREF of a Tropo endpoint, return the path
+    # otherwise, mash the args into the supplied template
+    def get_path(template, *args)
+      first = args.first
+      if first =~ /^#{endpoint}#{template.gsub('%d', '\d+').gsub('%s', '.*')}$/
+        uri = URI.parse(first)
+        uri.path
+      else
+        template % args
+      end
+    end
+
+    # Perform an HTTP request
+    def request(method, *args)
+      path, resource, options = extract_request_args!(*args)
+
+      # Do we need the session endpoint?
+      url     = path =~ /^\/?sessions/ ? session_endpoint : endpoint
+      # Need to parse XML for creating a session, but JSON for signals and everything else
+      format  = path =~ /^\/?sessions$/ ? :xml : :json
+
+      response = connection(url, format, resource).send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(path, options)
+        when :post, :put
+          request.path = path
+          request.body = options unless options.empty?
+        end
+      end
+      response.body
+    end
+  end
+end

data/lib/tropo_rest/resource/address.rb

@@ -0,0 +1,20 @@
+module TropoRest
+  module Resource
+    class Address < Hashie::Twash
+
+      property :href
+      property :type
+      property :prefix
+      property :number
+      property :address
+      property :city
+      property :state
+      property :channel
+      property :username
+      property :password
+      property :token
+      property :application_id
+
+    end
+  end
+end

data/lib/tropo_rest/resource/application.rb

@@ -0,0 +1,15 @@
+module TropoRest
+  module Resource
+    class Application < Hashie::Twash
+
+      property :id
+      property :href
+      property :name
+      property :voice_url, :from => :voiceUrl
+      property :messaging_url, :from => :messagingUrl
+      property :platform
+      property :partition
+
+    end
+  end
+end

data/lib/tropo_rest/resource/exchange.rb

@@ -0,0 +1,13 @@
+module TropoRest
+  module Resource
+    class Exchange < Hashie::Twash
+
+      property :prefix
+      property :city
+      property :state
+      property :country
+      property :description
+
+    end
+  end
+end

data/lib/tropo_rest/utils.rb

@@ -0,0 +1,33 @@
+module TropoRest
+  # Utilities
+  class Utils
+    # Convert hash keys from camel case to underscore
+    def self.underscore(hash)
+      dup = hash.dup
+      dup.keys.select { |k| k =~ /[A-Z]/ }.each do |k|
+        value = dup.delete(k)
+        key = k.dup
+        key.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+        key.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        key.tr!("-", "_")
+        key.downcase!
+        dup[key] = value
+      end
+      dup
+    end
+
+    # Convert hash keys from underscore to camel case
+    def self.camelize(hash)
+      dup = hash.dup
+      dup.keys.each do |k|
+        value = dup.delete(k)
+        key = k.to_s.dup
+        if key =~ /_/
+          key = key[0].chr.downcase + key.gsub(/(?:^|_)(.)/) { $1.upcase }[1..-1]
+        end
+        dup[key] = value
+      end
+      dup
+    end
+  end
+end

data/lib/tropo_rest/version.rb

@@ -0,0 +1,3 @@
+module TropoRest
+  VERSION = "0.0.1"
+end

data/lib/tropo_rest.rb

@@ -0,0 +1,31 @@
+require 'hashie/twash'
+
+require 'tropo_rest/resource/address'
+require 'tropo_rest/resource/application'
+require 'tropo_rest/resource/exchange'
+
+require 'tropo_rest/version'
+require 'tropo_rest/error'
+require 'tropo_rest/configuration'
+require 'tropo_rest/request'
+require 'tropo_rest/connection'
+require 'tropo_rest/client'
+require 'tropo_rest/utils'
+
+module TropoRest
+  extend Configuration
+
+  # Alias for TropoRest::Client.new
+  #
+  # @param options [Hash] Configuration options.
+  # @return [TropoRest::Client]
+  def self.client(options={})
+    TropoRest::Client.new(options)
+  end
+
+  # Delegate to TropoRest::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+end

data/script/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require 'bundler'
+Bundler.require
+
+require "irb"
+require 'tropo_rest'
+
+IRB.start(__FILE__)

data/spec/spec_helper.rb

@@ -0,0 +1,64 @@
+Bundler.require
+require 'tropo_rest'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.include WebMock::API
+end
+
+def a_delete(path)
+  a_request(:delete, tropo_url_for(path))
+end
+
+def a_get(path)
+  a_request(:get, tropo_url_for(path))
+end
+
+def a_post(path)
+  a_request(:post, tropo_url_for(path))
+end
+
+def a_put(path)
+  a_request(:put, tropo_url_for(path))
+end
+
+def stub_delete(path)
+  stub_request(:delete, tropo_url_for(path))
+end
+
+def stub_get(path)
+  stub_request(:get, tropo_url_for(path))
+end
+
+def stub_post(path)
+  stub_request(:post, tropo_url_for(path))
+end
+
+def stub_put(path)
+  stub_request(:put, tropo_url_for(path))
+end
+
+def a_session_get(path)
+  a_request(:get, tropo_session_url_for(path))
+end
+
+def a_session_post(path)
+  a_request(:post, tropo_session_url_for(path))
+end
+
+def stub_session_get(path)
+  stub_request(:get, tropo_session_url_for(path))
+end
+
+def stub_session_post(path)
+  stub_request(:post, tropo_session_url_for(path))
+end
+
+def tropo_url_for(path)
+  TropoRest.endpoint + path
+end
+
+def tropo_session_url_for(path)
+  TropoRest.session_endpoint + path
+end

data/spec/tropo_rest/client/address_spec.rb

@@ -0,0 +1,172 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe TropoRest::Client do
+
+  before do
+    @client = TropoRest::Client.new
+  end
+
+  describe "#addresses" do
+
+    before do
+      stub_get("applications/123456/addresses").to_return(:body => <<-JSON
+        [
+          {
+            "href": "https://api.tropo.com/v1/applications/123456/addresses/sip/99901123456@sip.tropo.com",
+            "type": "sip",
+            "address": "9990123456@sip.tropo.com"
+          },
+          {
+            "href": "https://api.tropo.com/v1/applications/123456/addresses/skype/+99000936209990123456",
+            "type": "skype",
+            "number": "+990009369990123456"
+          },
+          {
+            "href": "https://api.tropo.com/v1/applications/123456/addresses/number/+14075551234",
+            "type": "number",
+            "prefix": "1407",
+            "number": "4075551234",
+            "city": "Orlando",
+            "state": "FL"
+          },
+          {
+            "href": "https://api.tropo.com/v1/applications/123456/addresses/aim/tropocloud",
+            "type": "aim",
+            "username": "tropocloud"
+          }
+        ]
+        JSON
+      )
+    end
+
+    it "should make the request with an application ID" do
+      @client.addresses(123456)
+      a_get("applications/123456/addresses").should have_been_made
+    end
+
+    it "should make the request with an address HREF" do
+      @client.addresses("https://api.tropo.com/v1/applications/123456/addresses")
+      a_get("applications/123456/addresses").should have_been_made
+    end
+
+    it "should return a collection of addresses" do
+      @client.addresses(123456).should have(4).items
+    end
+
+    it "should return the correct addresses" do
+      apps    = @client.addresses(123456)
+      first   = apps[0]
+      second  = apps[1]
+      third   = apps[2]
+      fourth  = apps[3]
+
+      first.should be_instance_of(TropoRest::Resource::Address)
+      first.href.should      == "https://api.tropo.com/v1/applications/123456/addresses/sip/99901123456@sip.tropo.com"
+      first.type.should      == "sip"
+      first.address.should   == "9990123456@sip.tropo.com"
+
+      second.should be_instance_of(TropoRest::Resource::Address)
+      second.href.should     == "https://api.tropo.com/v1/applications/123456/addresses/skype/+99000936209990123456"
+      second.type.should     == "skype"
+      second.number.should   == "+990009369990123456"
+
+      third.should be_instance_of(TropoRest::Resource::Address)
+      third.href.should      == "https://api.tropo.com/v1/applications/123456/addresses/number/+14075551234"
+      third.type.should      == "number"
+      third.prefix.should    == "1407"
+      third.number.should    == "4075551234"
+      third.city.should      == "Orlando"
+      third.state.should     == "FL"
+
+      fourth.should be_instance_of(TropoRest::Resource::Address)
+      fourth.href.should     == "https://api.tropo.com/v1/applications/123456/addresses/aim/tropocloud"
+      fourth.type.should     == "aim"
+      fourth.username.should == "tropocloud"
+    end
+
+  end
+
+  describe "#address" do
+
+    before do
+      stub_get("applications/123456/addresses/skype/+99000936209990123456").to_return(:body => <<-JSON
+        {
+          "href": "https://api.tropo.com/v1/applications/123456/addresses/skype/+99000936209990123456",
+          "type": "skype",
+          "number": "+990009369990123456"
+        }
+        JSON
+      )
+    end
+
+    it "should make the request with application ID, address type, and address identifier" do
+      @client.address(123456, "skype", "+99000936209990123456")
+      a_get("applications/123456/addresses/skype/+99000936209990123456").should have_been_made
+    end
+
+    it "should make the request with an address HREF" do
+      @client.address("https://api.tropo.com/v1/applications/123456/addresses/skype/+99000936209990123456")
+      a_get("applications/123456/addresses/skype/+99000936209990123456").should have_been_made
+    end
+
+    it "should return an address object" do
+      app = @client.address(123456, "skype", "+99000936209990123456")
+      app.should be_instance_of(TropoRest::Resource::Address)
+      app.href.should    == "https://api.tropo.com/v1/applications/123456/addresses/skype/+99000936209990123456"
+      app.type.should    == "skype"
+      app.number.should  == "+990009369990123456"
+    end
+
+  end
+
+  describe "#create_address" do
+
+    before do
+      @params = {:type => "number", :prefix => "1407"}
+      stub_post("applications/123456/addresses").
+        with(:body => @params).
+        to_return(:body => %({"href":"https://api.tropo.com/v1/applications/123456/addresses/number/+14075551234"}))
+    end
+
+    it "should make the request with an application ID" do
+      @client.create_address(123456, @params)
+      a_post("applications/123456/addresses").with(:body => @params).should have_been_made
+    end
+
+    it "should make the request with an application HREF" do
+      @client.create_address("https://api.tropo.com/v1/applications/123456/addresses", @params)
+      a_post("applications/123456/addresses").with(:body => @params).should have_been_made
+    end
+
+    it "should return the href of the address" do
+      res = @client.create_address(123456, @params)
+      res.href.should == "https://api.tropo.com/v1/applications/123456/addresses/number/+14075551234"
+    end
+
+  end
+
+  describe "#delete_address" do
+
+    before do
+      stub_delete("applications/123456/addresses/skype/+99000936209990123456").
+        to_return(:body => %({"message": "delete successful"}))
+    end
+
+    it "should make the request with application ID, address type, and address identifier" do
+      @client.delete_address(123456, "skype", "+99000936209990123456")
+      a_delete("applications/123456/addresses/skype/+99000936209990123456").should have_been_made
+    end
+
+    it "should make the request with an address HREF" do
+      @client.delete_address("https://api.tropo.com/v1/applications/123456/addresses/skype/+99000936209990123456")
+      a_delete("applications/123456/addresses/skype/+99000936209990123456").should have_been_made
+    end
+
+    it "should return the message" do
+      res = @client.delete_address(123456, "skype", "+99000936209990123456")
+      res.message.should == "delete successful"
+    end
+
+  end
+
+end