twilio-rb 0.2.0 → 0.3.1

data/README.md

@@ -3,6 +3,18 @@
 
 Interact with the Twilio API in a nice Ruby way
 
+## Installation
+
+The library has been packaged as a gem and is available from rubygems.org
+
+<pre>gem install twilio-rb</pre>
+
+## Usage
+
+Require the library in your script as
+
+<pre>require 'twilio'</pre>
+
 ## Configuration
 
 Configuration for this library is encapsulated within `Twilio::Config`. One needs to setup with an Account SID and an Auth Token, e.g.
@@ -15,6 +27,28 @@ end</pre>
 
 Any method that calls the Twilio API will raise `Twilio::ConfigurationError` if either Account SID or Auth Token are not configured.
 
+## The Account object
+
+The Twilio API in its current incarnation supports one Twilio account per Account SID, and so the Twilio::Account object correspondingly is a singleton object.
+
+To access properties of the account the property name should be called as a method on the object itself, e.g.
+
+<pre>Twilio::Account.friendly_name</pre>
+
+The first time a method is invoked on the object an API call is made to retrieve the data. The methods themselves are not defined until they are called, i.e. lazy evaluation. This strategy means that addtional properties added to subsequent versions of the API should not break the library.
+
+To reload the data when needed `Twilio::Account.reload!` will make another API call and update its own internal state.
+
+Predicate methods i.e. those ending in `?` map directly to the status of the account, e.g. `Twilio::Account.suspended?` returns true if Twilio have suspended your account. Again, all of these methods are defined on the fly.
+
+The only account property that can be modified via the REST API is the friendly name, e.g.
+
+<pre>Twilio::Account.friendly_name = "I'm so vain, I had to change my name!"</pre>
+
+This will update the API immediately with a PUT request.
+
+Please refer to the Twilio REST API documentation for an up to date list of properties.
+
 ## Making a telephone call
 
 The API used to make a telephone call is similar to interacting with an ActiveRecord model object.

data/lib/twilio/account.rb

@@ -0,0 +1,20 @@
+module Twilio
+  module Account
+    include Twilio::Resource
+    @attributes = {}
+
+    def attributes
+      @attributes.empty? ? reload! : @attributes
+    end
+
+    def reload!
+      handle_response get "/Accounts/#{Twilio::ACCOUNT_SID}.json"
+    end
+
+    def friendly_name=(name)
+      handle_response put "/Accounts/#{Twilio::ACCOUNT_SID}.json", :body => { :friendly_name => name }
+    end
+
+    extend self
+  end
+end

data/lib/twilio/call.rb

@@ -2,6 +2,13 @@ module Twilio
   class Call
     include Twilio::Resource
 
+    def initialize(attrs ={})  #:nodoc:
+      @attributes = Hash[attrs.map { |k,v| [k.to_s.camelize, v.to_s] }]
+      normalize_http_verbs!
+      escape_send_digits! if attributes.include? 'SendDigits'
+      normalize_if_machine_parameter!
+    end
+
     # Dials the call
     def save
       handle_response self.class.post "/Accounts/#{Twilio::ACCOUNT_SID}/Calls.json", :body => attributes
@@ -25,6 +32,21 @@ module Twilio
 
     private
 
+    def normalize_http_verbs! #:nodoc:
+      # Twilio accepts a HTTP method for use with various callbacks. The API documentation
+      # indicates that the HTTP verbs are to be passed as upcase.
+      attributes.each { |k,v| v.upcase! if k =~ /Method$/ }
+    end
+
+    def escape_send_digits! #:nodoc:
+      # A pound, i.e. "#" has special meaning in a URL so it must be escaped
+      attributes.update 'SendDigits' => CGI.escape(attributes['SendDigits'])
+    end
+
+    def normalize_if_machine_parameter! #:nodoc:
+      attributes['IfMachine'].capitalize! if attributes['IfMachine']
+    end
+
     def state_guard(&blk)
       if self[:status] # If this attribute exists it is assumed the API call to create a call has been made, and the object is in the correct state to make request.
         blk.call

data/lib/twilio/resource.rb

@@ -2,13 +2,6 @@ require 'active_support/core_ext/string/inflections' # Chill! we only use the bi
 
 module Twilio
   module Resource
-    def initialize(attrs ={})  #:nodoc:
-      @attributes = Hash[attrs.map { |k,v| [k.to_s.camelize, v.to_s] }]
-      normalize_http_verbs!
-      escape_send_digits! if attributes.include? 'SendDigits'
-      normalize_if_machine_parameter!
-    end
-
     # Convenience for accessing attributes. Attributes can be accessed either using the
     # preferred symbol style, e.g. :if_machine or using the Twilio stringified attribute
     # style, e.g. 'IfMachine'
@@ -29,31 +22,19 @@ module Twilio
       if res.code.to_s =~ /^(4|5)\d\d/
         raise Twilio::APIError.new "Error ##{res.parsed_response['code']}: #{res.parsed_response['message']}"
       else
-        attributes.update Hash[res.parsed_response.map { |k,v| [k.camelize, v] }] # params are camelized in requests, yet underscored in the repsonse. inconsistency FTW!
+        @attributes.update Hash[res.parsed_response.map { |k,v| [k.camelize, v] }] # params are camelized in requests, yet underscored in the repsonse. inconsistency FTW!
       end
     end
 
-    def normalize_http_verbs! #:nodoc:
-      # Twilio accepts a HTTP method for use with various callbacks. The API documentation
-      # indicates that the HTTP verbs are to be passed as upcase.
-      attributes.each { |k,v| v.upcase! if k =~ /Method$/ }
-    end
-
-    def escape_send_digits! #:nodoc:
-      # A pound, i.e. "#" has special meaning in a URL so it must be escaped
-      attributes.update 'SendDigits' => CGI.escape(attributes['SendDigits'])
-    end
-
-    def normalize_if_machine_parameter! #:nodoc:
-      attributes['IfMachine'].capitalize! if attributes['IfMachine']
-    end
-
-    def method_missing(meth, *args, &blk) #:nodoc
-      meth = meth.to_s.camelize
-      if meth.to_s =~ /\=$/
+    def method_missing(id, *args, &blk) #:nodoc
+      meth = id.to_s
+      if meth =~ /\=$/
         add_attr_writer meth
         send meth, args.first
-      elsif attributes.include? meth = meth.gsub('=', '')
+      elsif meth =~ /^#{meth}\?/i
+        add_predicate meth
+        send meth
+      elsif self[id]
         add_attr_reader meth
         send meth
       else
@@ -61,16 +42,21 @@ module Twilio
       end
     end
 
+    def add_predicate(attribute)
+      metaclass.class_eval do
+        define_method(attribute) { self[:status] =~ /^#{attribute.gsub '?', ''}/i ? true : false }
+      end
+    end
+
     def add_attr_writer(attribute) #:nodoc
       metaclass.class_eval do
-        attribute = attribute.to_s.gsub(/\=$/, '')
-        define_method("#{attribute}=") { |value| attributes[attribute] = value } unless respond_to? "#{attribute}="
+        define_method(attribute) { |value| self[attribute.to_s.gsub(/\=$/, '').to_sym] = value } unless respond_to? attribute
       end
     end
 
     def add_attr_reader(attribute) #:nodoc
       metaclass.class_eval do
-        define_method(attribute) { attributes[attribute] } unless respond_to? attribute
+        define_method(attribute) { self[attribute.to_sym] } unless respond_to? attribute
       end
     end
 
@@ -89,10 +75,14 @@ module Twilio
       class << base
         def create(attrs={})
           new(attrs).tap { |c| c.save }
-        end
-
-        def post(url, opts)
-          super url, opts.merge(:basic_auth => { :username => Twilio::ACCOUNT_SID, :password => Twilio::AUTH_TOKEN })
+        end if instance_of? Class # Don't want this mixed into singleton objects e.g. Twilio::Account 
+        
+        # decorate http methods with authentication
+        %w<post get put delete>.each do |meth| 
+          define_method(meth) do |*args| # splatted args necessary hack since <= 1.8.7 does not support optional block args 
+            opts = args[1] || {}
+            super args.first, opts.merge(:basic_auth => { :username => Twilio::ACCOUNT_SID, :password => Twilio::AUTH_TOKEN })
+          end
         end
       end
     end

data/lib/twilio/sms.rb

@@ -2,6 +2,10 @@ module Twilio
   class SMS
     include Twilio::Resource
 
+    def initialize(attrs ={})  #:nodoc:
+      @attributes = Hash[attrs.map { |k,v| [k.to_s.camelize, v.to_s] }]
+    end
+
     # Sends the SMS message
     def save
       handle_response self.class.post "/Accounts/#{Twilio::ACCOUNT_SID}/SMS/Messages.json", :body => attributes

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 0
-  version: 0.2.0
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Stevie Graham
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-28 00:00:00 +01:00
+date: 2010-09-30 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -102,6 +102,7 @@ extra_rdoc_files: []
 
 files: 
 - README.md
+- lib/twilio/account.rb
 - lib/twilio/call.rb
 - lib/twilio/config.rb
 - lib/twilio/resource.rb