groupme-trails 1.1.5.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (56) hide show
  1. data/History.txt +49 -0
  2. data/Manifest.txt +55 -0
  3. data/README.txt +46 -0
  4. data/Rakefile +11 -0
  5. data/assets/layouts/default_layout.twiml.builder +4 -0
  6. data/bin/trails +0 -0
  7. data/lib/trails.rb +13 -0
  8. data/lib/trails/exception.rb +6 -0
  9. data/lib/trails/test_helper.rb +147 -0
  10. data/lib/trails/twilio/account.rb +203 -0
  11. data/lib/trails/twilio/call_handling.rb +52 -0
  12. data/lib/trails/twilio/incoming.rb +67 -0
  13. data/lib/twiliorest.rb +115 -0
  14. data/test/example/README +243 -0
  15. data/test/example/Rakefile +10 -0
  16. data/test/example/app/controllers/application_controller.rb +11 -0
  17. data/test/example/app/controllers/calls_controller.rb +8 -0
  18. data/test/example/app/helpers/application_helper.rb +3 -0
  19. data/test/example/app/helpers/calls_helper.rb +2 -0
  20. data/test/example/app/views/calls/index.html.erb +1 -0
  21. data/test/example/app/views/calls/index.twiml.builder +2 -0
  22. data/test/example/config/boot.rb +110 -0
  23. data/test/example/config/database.yml +22 -0
  24. data/test/example/config/environment.rb +43 -0
  25. data/test/example/config/environments/development.rb +17 -0
  26. data/test/example/config/environments/production.rb +28 -0
  27. data/test/example/config/environments/test.rb +28 -0
  28. data/test/example/config/initializers/backtrace_silencers.rb +7 -0
  29. data/test/example/config/initializers/inflections.rb +10 -0
  30. data/test/example/config/initializers/mime_types.rb +5 -0
  31. data/test/example/config/initializers/new_rails_defaults.rb +21 -0
  32. data/test/example/config/initializers/session_store.rb +15 -0
  33. data/test/example/config/locales/en.yml +5 -0
  34. data/test/example/config/routes.rb +43 -0
  35. data/test/example/config/twilio.yml +3 -0
  36. data/test/example/db/development.sqlite3 +0 -0
  37. data/test/example/db/schema.rb +14 -0
  38. data/test/example/db/seeds.rb +7 -0
  39. data/test/example/db/test.sqlite3 +0 -0
  40. data/test/example/doc/README_FOR_APP +2 -0
  41. data/test/example/script/about +4 -0
  42. data/test/example/script/console +3 -0
  43. data/test/example/script/dbconsole +3 -0
  44. data/test/example/script/destroy +3 -0
  45. data/test/example/script/generate +3 -0
  46. data/test/example/script/performance/benchmarker +3 -0
  47. data/test/example/script/performance/profiler +3 -0
  48. data/test/example/script/plugin +3 -0
  49. data/test/example/script/runner +3 -0
  50. data/test/example/script/server +3 -0
  51. data/test/example/test/functional/calls_controller_test.rb +15 -0
  52. data/test/example/test/performance/browsing_test.rb +9 -0
  53. data/test/example/test/test_helper.rb +38 -0
  54. data/test/example/test/unit/helpers/calls_helper_test.rb +4 -0
  55. data/test/test_trails.rb +11 -0
  56. metadata +160 -0
@@ -0,0 +1,52 @@
1
+ module Trails
2
+ module Twilio
3
+ module CallHandling
4
+ def self.included( klass )
5
+ raise "can\'t include #{self} in #{klass} - not a Controller?" unless
6
+ klass.respond_to?( :before_filter )
7
+ Mime::Type.register_alias( "text/html", :twiml ) unless Mime.const_defined?( 'TWIML' )
8
+ klass.send( :prepend_before_filter, :setup_incoming_call )
9
+ klass.send( :attr_reader, :incoming_call )
10
+ klass.send( :alias_method_chain, :protect_against_forgery?, :twilio )
11
+ klass.send( :append_view_path, File.expand_path( File.join( File.dirname( __FILE__ ),
12
+ '../../../assets' ) ) )
13
+ klass.send( :alias_method_chain, :default_layout, :twilio )
14
+ end
15
+
16
+ protected
17
+
18
+ def default_layout_with_twilio
19
+ is_twilio_call? ? twiml_layout : default_layout_without_twilio
20
+ end
21
+
22
+ def twiml_layout
23
+ 'default_layout.twiml.builder'
24
+ end
25
+
26
+ def protect_against_forgery_with_twilio?
27
+ is_twilio_call? ? false : protect_against_forgery_without_twilio?
28
+ end
29
+
30
+ def setup_incoming_call
31
+ return unless is_twilio_call?
32
+ logger.debug{ "at the beginning, request.params = #{request.parameters}" }
33
+ request.format = :twiml
34
+ response.content_type = 'text/xml'
35
+
36
+ @incoming_call = Trails::Twilio::Incoming.new( request )
37
+ end
38
+
39
+ # TODO: Move this onto the request object,
40
+ # it makes more sense to say:
41
+ #
42
+ # request.is_twilio_call?
43
+ #
44
+ def is_twilio_call?
45
+ return !Trails::Twilio::Account.sid_from_request( request ).blank?
46
+ end
47
+
48
+ protected
49
+
50
+ end # module CallHandling
51
+ end # module Twilio
52
+ end # module Trails
@@ -0,0 +1,67 @@
1
+ module Trails
2
+ module Twilio
3
+ class Incoming
4
+ attr_reader :account
5
+ def initialize( request, opts = {} )
6
+ @request = request
7
+ @account = Trails::Twilio::Account.from_request( request )
8
+ end
9
+
10
+ def twilio_data
11
+ request.params.slice( *INCOMING_VARS ).dup
12
+ end
13
+
14
+ def is_sms?
15
+ !sms_message_sid.blank?
16
+ end
17
+
18
+ def complete?
19
+ 'completed' == self.call_status.downcase
20
+ end
21
+
22
+ protected
23
+ attr_reader :request
24
+
25
+ INCOMING_VARS = [
26
+ # Always available:
27
+ 'CallGuid', # A unique identifier for this call, generated by Twilio. It's 34 characters long, and always starts with the letters CA.
28
+ 'Caller', # The phone number of the party that initiated the call. If the call is inbound, then it is the caller's caller-id. If the call is outbound, i.e., initiated by making a request to the REST Call API, then this is the phone number you specify as the caller-id.
29
+ 'Called', # The phone number of the party that was called. If the call is inbound, then it's your application phone number. If the call is outbound, then it's the phone number you provided to call.
30
+ 'AccountGuid', # Your Twilio account number which is the Twilio Account GUID for the call. It is 34 characters long, and always starts with the letters AC.
31
+ 'CallStatus', # The status of the phone call. The value can be "in-progress", "completed", "busy", "failed" or "no-answer". For a call that was answered and is currently going on, the status would be "in-progress". For a call that couldn't be started because the called party was busy, didn't pick up, or the number dialed wasn't valid: "busy", "no-answer", or "failed" would be returned. If the call finished because the call ended or was hung up, the status would be "completed".
32
+ 'CallerCity', # The city of the caller.
33
+ 'CallerState', # The state or province of the caller.
34
+ 'CallerZip', # The postal code of the caller.
35
+ 'CallerCountry', # The country of the caller.
36
+ 'CalledCity', # The city of the called party.
37
+ 'CalledState', # The state or province of the called party.
38
+ 'CalledZip', # The postal code of the called party.
39
+ 'CalledCountry', # The country of the called party.
40
+ # Gather:
41
+ 'Digits', # The digits received from the caller
42
+
43
+ 'RecordingUrl', # The URL of the recorded audio file
44
+ 'Duration', # The time duration of the recorded audio file
45
+ 'Digits', # What (if any) key was pressed to end the recording
46
+
47
+ # SMS:
48
+ 'SmsMessageSid', # Message SID
49
+ 'AccountSid', # Account ID
50
+ 'From', #
51
+ 'To', #
52
+ 'Body', # 160 chars
53
+
54
+ ].freeze
55
+ public
56
+ INCOMING_VARS.uniq.each do |pname|
57
+ mname = pname.gsub( /[A-Z]/ ) { |s| "_#{s.downcase}" }.gsub( /^_/, '' )
58
+ # some extra debugging code here:
59
+ # ActionController::Base.logger.debug{ "defining method: #{mname} for param #{pname}" }
60
+ define_method( mname ) do
61
+ return request.params[ pname ] || request.env["HTTP_X_TWILIO_#{pname.upcase}"]
62
+ end # define_method
63
+ end # each
64
+
65
+ end #
66
+ end # module Twilio
67
+ end # module Trails
@@ -0,0 +1,115 @@
1
+ =begin
2
+ Copyright (c) 2008 Twilio, Inc.
3
+
4
+ Permission is hereby granted, free of charge, to any person
5
+ obtaining a copy of this software and associated documentation
6
+ files (the "Software"), to deal in the Software without
7
+ restriction, including without limitation the rights to use,
8
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the
10
+ Software is furnished to do so, subject to the following
11
+ conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
18
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
20
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
21
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23
+ OTHER DEALINGS IN THE SOFTWARE.
24
+ =end
25
+
26
+ module TwilioRest
27
+ require 'net/http'
28
+ require 'net/https'
29
+ require 'uri'
30
+ require 'cgi'
31
+
32
+ TWILIO_API_URL = 'https://api.twilio.com'
33
+
34
+ class TwilioRest::Account
35
+
36
+ #initialize a twilio account object
37
+ #
38
+ #id: Twilio account SID/ID
39
+ #token: Twilio account token
40
+ #
41
+ #returns a Twilio account object
42
+ def initialize(id, token)
43
+ @id = id
44
+ @token = token
45
+ end
46
+
47
+ def _urlencode(params)
48
+ params.to_a.collect! \
49
+ { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join("&")
50
+ end
51
+
52
+ def _build_get_uri(uri, params)
53
+ if params && params.length > 0
54
+ if uri.include?('?')
55
+ if uri[-1, 1] != '&'
56
+ uri += '&'
57
+ end
58
+ uri += _urlencode(params)
59
+ else
60
+ uri += '?' + _urlencode(params)
61
+ end
62
+ end
63
+ return uri
64
+ end
65
+
66
+ def _fetch(url, params, method=nil)
67
+ if method && method == 'GET'
68
+ url = _build_get_uri(url, params)
69
+ end
70
+ uri = URI.parse(url)
71
+
72
+ http = Net::HTTP.new(uri.host, uri.port)
73
+ http.use_ssl = true
74
+
75
+ if method && method == 'GET'
76
+ req = Net::HTTP::Get.new(uri.request_uri)
77
+ elsif method && method == 'DELETE'
78
+ req = Net::HTTP::Delete.new(uri.request_uri)
79
+ elsif method && method == 'PUT'
80
+ req = Net::HTTP::Put.new(uri.request_uri)
81
+ req.set_form_data(params)
82
+ else
83
+ req = Net::HTTP::Post.new(uri.request_uri)
84
+ req.set_form_data(params)
85
+ end
86
+ req.basic_auth(@id, @token)
87
+
88
+ return http.request(req)
89
+ end
90
+
91
+ #sends a request and gets a response from the Twilio REST API
92
+ #
93
+ #path: the URL (relative to the endpoint URL, after the /v1
94
+ #url: the HTTP method to use, defaults to POST
95
+ #vars: for POST or PUT, a dict of data to send
96
+ #
97
+ #returns Twilio response XML or raises an exception on error
98
+ def request(path, method=nil, vars={})
99
+ if !path || path.length < 1
100
+ raise ArgumentError, 'Invalid path parameter'
101
+ end
102
+ if method && !['GET', 'POST', 'DELETE', 'PUT'].include?(method)
103
+ raise NotImplementedError, 'HTTP %s not implemented' % method
104
+ end
105
+
106
+ if path[0, 1] == '/'
107
+ uri = TWILIO_API_URL + path
108
+ else
109
+ uri = TWILIO_API_URL + '/' + path
110
+ end
111
+
112
+ return _fetch(uri, vars, method)
113
+ end
114
+ end
115
+ end
@@ -0,0 +1,243 @@
1
+ == Welcome to Rails
2
+
3
+ Rails is a web-application framework that includes everything needed to create
4
+ database-backed web applications according to the Model-View-Control pattern.
5
+
6
+ This pattern splits the view (also called the presentation) into "dumb" templates
7
+ that are primarily responsible for inserting pre-built data in between HTML tags.
8
+ The model contains the "smart" domain objects (such as Account, Product, Person,
9
+ Post) that holds all the business logic and knows how to persist themselves to
10
+ a database. The controller handles the incoming requests (such as Save New Account,
11
+ Update Product, Show Post) by manipulating the model and directing data to the view.
12
+
13
+ In Rails, the model is handled by what's called an object-relational mapping
14
+ layer entitled Active Record. This layer allows you to present the data from
15
+ database rows as objects and embellish these data objects with business logic
16
+ methods. You can read more about Active Record in
17
+ link:files/vendor/rails/activerecord/README.html.
18
+
19
+ The controller and view are handled by the Action Pack, which handles both
20
+ layers by its two parts: Action View and Action Controller. These two layers
21
+ are bundled in a single package due to their heavy interdependence. This is
22
+ unlike the relationship between the Active Record and Action Pack that is much
23
+ more separate. Each of these packages can be used independently outside of
24
+ Rails. You can read more about Action Pack in
25
+ link:files/vendor/rails/actionpack/README.html.
26
+
27
+
28
+ == Getting Started
29
+
30
+ 1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
31
+ and your application name. Ex: rails myapp
32
+ 2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
33
+ 3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
34
+ 4. Follow the guidelines to start developing your application
35
+
36
+
37
+ == Web Servers
38
+
39
+ By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
40
+ with a variety of other web servers.
41
+
42
+ Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
43
+ suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
44
+ getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
45
+ More info at: http://mongrel.rubyforge.org
46
+
47
+ Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
48
+ Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
49
+ FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
50
+
51
+ == Apache .htaccess example for FCGI/CGI
52
+
53
+ # General Apache options
54
+ AddHandler fastcgi-script .fcgi
55
+ AddHandler cgi-script .cgi
56
+ Options +FollowSymLinks +ExecCGI
57
+
58
+ # If you don't want Rails to look in certain directories,
59
+ # use the following rewrite rules so that Apache won't rewrite certain requests
60
+ #
61
+ # Example:
62
+ # RewriteCond %{REQUEST_URI} ^/notrails.*
63
+ # RewriteRule .* - [L]
64
+
65
+ # Redirect all requests not available on the filesystem to Rails
66
+ # By default the cgi dispatcher is used which is very slow
67
+ #
68
+ # For better performance replace the dispatcher with the fastcgi one
69
+ #
70
+ # Example:
71
+ # RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
72
+ RewriteEngine On
73
+
74
+ # If your Rails application is accessed via an Alias directive,
75
+ # then you MUST also set the RewriteBase in this htaccess file.
76
+ #
77
+ # Example:
78
+ # Alias /myrailsapp /path/to/myrailsapp/public
79
+ # RewriteBase /myrailsapp
80
+
81
+ RewriteRule ^$ index.html [QSA]
82
+ RewriteRule ^([^.]+)$ $1.html [QSA]
83
+ RewriteCond %{REQUEST_FILENAME} !-f
84
+ RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
85
+
86
+ # In case Rails experiences terminal errors
87
+ # Instead of displaying this message you can supply a file here which will be rendered instead
88
+ #
89
+ # Example:
90
+ # ErrorDocument 500 /500.html
91
+
92
+ ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
93
+
94
+
95
+ == Debugging Rails
96
+
97
+ Sometimes your application goes wrong. Fortunately there are a lot of tools that
98
+ will help you debug it and get it back on the rails.
99
+
100
+ First area to check is the application log files. Have "tail -f" commands running
101
+ on the server.log and development.log. Rails will automatically display debugging
102
+ and runtime information to these files. Debugging info will also be shown in the
103
+ browser on requests from 127.0.0.1.
104
+
105
+ You can also log your own messages directly into the log file from your code using
106
+ the Ruby logger class from inside your controllers. Example:
107
+
108
+ class WeblogController < ActionController::Base
109
+ def destroy
110
+ @weblog = Weblog.find(params[:id])
111
+ @weblog.destroy
112
+ logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
113
+ end
114
+ end
115
+
116
+ The result will be a message in your log file along the lines of:
117
+
118
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
119
+
120
+ More information on how to use the logger is at http://www.ruby-doc.org/core/
121
+
122
+ Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
123
+
124
+ * The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
125
+ * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
126
+
127
+ These two online (and free) books will bring you up to speed on the Ruby language
128
+ and also on programming in general.
129
+
130
+
131
+ == Debugger
132
+
133
+ Debugger support is available through the debugger command when you start your Mongrel or
134
+ Webrick server with --debugger. This means that you can break out of execution at any point
135
+ in the code, investigate and change the model, AND then resume execution!
136
+ You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
137
+ Example:
138
+
139
+ class WeblogController < ActionController::Base
140
+ def index
141
+ @posts = Post.find(:all)
142
+ debugger
143
+ end
144
+ end
145
+
146
+ So the controller will accept the action, run the first line, then present you
147
+ with a IRB prompt in the server window. Here you can do things like:
148
+
149
+ >> @posts.inspect
150
+ => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
151
+ #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
152
+ >> @posts.first.title = "hello from a debugger"
153
+ => "hello from a debugger"
154
+
155
+ ...and even better is that you can examine how your runtime objects actually work:
156
+
157
+ >> f = @posts.first
158
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
159
+ >> f.
160
+ Display all 152 possibilities? (y or n)
161
+
162
+ Finally, when you're ready to resume execution, you enter "cont"
163
+
164
+
165
+ == Console
166
+
167
+ You can interact with the domain model by starting the console through <tt>script/console</tt>.
168
+ Here you'll have all parts of the application configured, just like it is when the
169
+ application is running. You can inspect domain models, change values, and save to the
170
+ database. Starting the script without arguments will launch it in the development environment.
171
+ Passing an argument will specify a different environment, like <tt>script/console production</tt>.
172
+
173
+ To reload your controllers and models after launching the console run <tt>reload!</tt>
174
+
175
+ == dbconsole
176
+
177
+ You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
178
+ You would be connected to the database with the credentials defined in database.yml.
179
+ Starting the script without arguments will connect you to the development database. Passing an
180
+ argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
181
+ Currently works for mysql, postgresql and sqlite.
182
+
183
+ == Description of Contents
184
+
185
+ app
186
+ Holds all the code that's specific to this particular application.
187
+
188
+ app/controllers
189
+ Holds controllers that should be named like weblogs_controller.rb for
190
+ automated URL mapping. All controllers should descend from ApplicationController
191
+ which itself descends from ActionController::Base.
192
+
193
+ app/models
194
+ Holds models that should be named like post.rb.
195
+ Most models will descend from ActiveRecord::Base.
196
+
197
+ app/views
198
+ Holds the template files for the view that should be named like
199
+ weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
200
+ syntax.
201
+
202
+ app/views/layouts
203
+ Holds the template files for layouts to be used with views. This models the common
204
+ header/footer method of wrapping views. In your views, define a layout using the
205
+ <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
206
+ call <% yield %> to render the view using this layout.
207
+
208
+ app/helpers
209
+ Holds view helpers that should be named like weblogs_helper.rb. These are generated
210
+ for you automatically when using script/generate for controllers. Helpers can be used to
211
+ wrap functionality for your views into methods.
212
+
213
+ config
214
+ Configuration files for the Rails environment, the routing map, the database, and other dependencies.
215
+
216
+ db
217
+ Contains the database schema in schema.rb. db/migrate contains all
218
+ the sequence of Migrations for your schema.
219
+
220
+ doc
221
+ This directory is where your application documentation will be stored when generated
222
+ using <tt>rake doc:app</tt>
223
+
224
+ lib
225
+ Application specific libraries. Basically, any kind of custom code that doesn't
226
+ belong under controllers, models, or helpers. This directory is in the load path.
227
+
228
+ public
229
+ The directory available for the web server. Contains subdirectories for images, stylesheets,
230
+ and javascripts. Also contains the dispatchers and the default HTML files. This should be
231
+ set as the DOCUMENT_ROOT of your web server.
232
+
233
+ script
234
+ Helper scripts for automation and generation.
235
+
236
+ test
237
+ Unit and functional tests along with fixtures. When using the script/generate scripts, template
238
+ test files will be generated for you and placed in this directory.
239
+
240
+ vendor
241
+ External libraries that the application depends on. Also includes the plugins subdirectory.
242
+ If the app has frozen rails, those gems also go here, under vendor/rails/.
243
+ This directory is in the load path.