Heroku addons development - Nov 2011
0 likes1,149 views
This document discusses how to develop Heroku add-ons for hosted services. It explains that exposing your service as a Heroku add-on allows you to reach a wider audience and grow your user base. It outlines the steps to create an add-on using the Kensa testing framework, including writing provisioning and authentication code, running local tests, and deploying the add-on for users to install. Becoming an official Heroku add-on provider allows users to easily add the service with the 'heroku addons:add' command.
![Kensa
Heroku add-on development, TDD style
$ gem install kensa
$ cd /letmein
$ kensa init
addon-manifest.json
{
"id": "letmein",
"api": {
"config_vars": [ "LETMEIN_URL" ],
"password": "pXrE4efbslOkCHtu",
"sso_salt": "qi198QaiuPsE6DWq",
"production": "https://letmein.herokuapp.com/",
"test": "http://localhost:5000/"
}](https://image.slidesharecdn.com/heroku-addons-preso-nov-2011-120128074738-phpapp01/85/Heroku-addons-development-Nov-2011-10-320.jpg)
![Kensa
Oops.
$ kensa test provision
Testing POST /heroku/resources
Check response [FAIL]
! expected 200, got 404
done.](https://image.slidesharecdn.com/heroku-addons-preso-nov-2011-120128074738-phpapp01/85/Heroku-addons-development-Nov-2011-11-320.jpg)
![Kensa
What’s next?
$ kensa test provision
Testing POST /heroku/resources
Check response [PASS]
Check valid JSON [PASS]
Check authentication [FAIL]
! expected 401, got 200
done.
Point is, Kensa will tell you what to do!](https://image.slidesharecdn.com/heroku-addons-preso-nov-2011-120128074738-phpapp01/85/Heroku-addons-development-Nov-2011-13-320.jpg)
![The consumer app
and the minimalist letmein plugin
def authenticate!
redirect "#{ENV["LETMEIN_URL"]}/authenticate?return_to=#{url('/callback')}"
end
before '/protected/*' do
authenticate! unless session[:user]
end](https://image.slidesharecdn.com/heroku-addons-preso-nov-2011-120128074738-phpapp01/85/Heroku-addons-development-Nov-2011-14-320.jpg)
![Local end to end test
and little demo!
$ kensa run ruby ../letmein-consumer/app.rb
Testing POST /heroku/resources
Check response [PASS]
Check valid JSON [PASS]
Check authentication [PASS]
...
Testing DELETE /heroku/resources/5f3feb3dfb2bc20f29d14c49f4567599dbb0345f
Check response [PASS]
Check authentication [PASS]
done.](https://image.slidesharecdn.com/heroku-addons-preso-nov-2011-120128074738-phpapp01/85/Heroku-addons-development-Nov-2011-15-320.jpg)
Heroku addons development - Nov 2011
- 1. Developing Heroku add-ons for Heroku hosted services @leonardo_borges
- 2. self slide ➡ Consultant at ThoughtWorks Australia ➡ Programming languages enthusiast ➡ Developed the Queensland heroku powered app for the Floods of 2010/2011 ➡ Used by thousands ➡ Generated over $38 million in donations www.leonardoborges.com @leonardo_borges
- 3. Why?
- 4. Why? You’re good at something other people are not
- 5. Why? So you expose your service to a whole new market
- 6. Why? Grow your user base to tens of thousands
- 7. Why? Heroku promotes your service free buzz :) and makes it dead easy for users to get started
- 8. How?
- 9. How? Meet letmein, the polite authentication service authenticate your letmein customer’s ok/get out! app heroku
- 10. Kensa Heroku add-on development, TDD style $ gem install kensa $ cd /letmein $ kensa init addon-manifest.json { "id": "letmein", "api": { "config_vars": [ "LETMEIN_URL" ], "password": "pXrE4efbslOkCHtu", "sso_salt": "qi198QaiuPsE6DWq", "production": "https://letmein.herokuapp.com/", "test": "http://localhost:5000/" }
- 11. Kensa Oops. $ kensa test provision Testing POST /heroku/resources Check response [FAIL] ! expected 200, got 404 done.
- 12. Add-on provisioning Allocate resources for the app post '/heroku/resources' do api_key = Digest::SHA1.hexdigest(Time.now.to_s + rand(12341234).to_s) user = User.create(api_key: api_key, created_at: Time.now) result = { :id => user.api_key, :config => { "LETMEIN_URL" => url("/#{api_key}") } } result.to_json end
- 13. Kensa What’s next? $ kensa test provision Testing POST /heroku/resources Check response [PASS] Check valid JSON [PASS] Check authentication [FAIL] ! expected 401, got 200 done. Point is, Kensa will tell you what to do!
- 14. The consumer app and the minimalist letmein plugin def authenticate! redirect "#{ENV["LETMEIN_URL"]}/authenticate?return_to=#{url('/callback')}" end before '/protected/*' do authenticate! unless session[:user] end
- 15. Local end to end test and little demo! $ kensa run ruby ../letmein-consumer/app.rb Testing POST /heroku/resources Check response [PASS] Check valid JSON [PASS] Check authentication [PASS] ... Testing DELETE /heroku/resources/5f3feb3dfb2bc20f29d14c49f4567599dbb0345f Check response [PASS] Check authentication [PASS] done.
- 16. All set? Become an add-on provider https://addons.heroku.com/provider/signup
- 17. Then what? This is how your users will install the add-on $ heroku addons:add letmein -----> Adding letmein to letmein-consumer... done, v3 (free) $ heroku config LETMEIN_URL => https://letmein.herokuapp.com/e223a873c2e794e93fafaea9016327f1e668be3f ... ...and it’s time for another little demo!
- 18. w00t
- 19. Resources ➡ https://github.com/leonardoborges/letmein ➡ https://github.com/leonardoborges/letmein-consumer ➡ https://addons.heroku.com/provider ➡ http://www.heroku.com
- 20. Thank you! Questions? @leonardo_borges