JSON - Schmason - Speaker Deck

Slide 1

Slide 1 text

JSON - Schmason Using Rails for building Web APIs WebTech Conference 2012 Jan Krutisch http://jan.krutisch.de/ Dienstag, 16. Oktober 12

Slide 2

Slide 2 text

JSON - Schmason Using Rails for building Web APIs WebTech Conference 2012 Jan Krutisch http://jan.krutisch.de/ Dienstag, 16. Oktober 12

Slide 3

Slide 3 text

Designing Building Testing Dienstag, 16. Oktober 12

Slide 4

Slide 4 text

Assumptions Dienstag, 16. Oktober 12

Slide 5

Slide 5 text

JSON Dienstag, 16. Oktober 12

Slide 6

Slide 6 text

!XML Dienstag, 16. Oktober 12

Slide 7

Slide 7 text

Designing Dienstag, 16. Oktober 12

Slide 8

Slide 8 text

REST Dienstag, 16. Oktober 12

Slide 9

Slide 9 text

REpresenational State Transfer Dienstag, 16. Oktober 12

Slide 10

Slide 10 text

„Pragmatic REST“ Dienstag, 16. Oktober 12

Slide 11

Slide 11 text

POST /books.json GET /books.json GET /books/1.json PUT /books/1.json DELETE /books/1.json Dienstag, 16. Oktober 12

Slide 12

Slide 12 text

POST /books/1/comments.json GET /books/1/comments.json GET /books/1/comments/1.json PUT /books/1/comments/1.json DELETE /books/1/comments/1.json Dienstag, 16. Oktober 12

Slide 13

Slide 13 text

Hypermedia As The Engine Of Application State Dienstag, 16. Oktober 12

Slide 14

Slide 14 text

HATEOAS Dienstag, 16. Oktober 12

Slide 15

Slide 15 text

Hype As The Engine Of Acronym Silliness Dienstag, 16. Oktober 12

Slide 16

Slide 16 text

Hypermedia Dienstag, 16. Oktober 12

Slide 17

Slide 17 text

GET /books.json GET /books/1.json Dienstag, 16. Oktober 12

Slide 18

Slide 18 text

[...] "_links": { ! "self": {"href":"/books/1.json"}, ! "comments":{"href":"/books/1/comments.json"} } [...] Dienstag, 16. Oktober 12

Slide 19

Slide 19 text

Hypermedia As The Engine Of Application State Dienstag, 16. Oktober 12

Slide 20

Slide 20 text

REST Dienstag, 16. Oktober 12

Slide 21

Slide 21 text

Beneﬁts of Hypermedia Dienstag, 16. Oktober 12

Slide 22

Slide 22 text

API Versioning Dienstag, 16. Oktober 12

Slide 23

Slide 23 text

foo.com/api/v1/ Dienstag, 16. Oktober 12

Slide 24

Slide 24 text

Don't do it! Dienstag, 16. Oktober 12

Slide 25

Slide 25 text

Try to avoid it Dienstag, 16. Oktober 12

Slide 26

Slide 26 text

Code Duplication Dienstag, 16. Oktober 12

Slide 27

Slide 27 text

Legacy Code Dienstag, 16. Oktober 12

Slide 28

Slide 28 text

if request.version < 2 fffffffffuuuuuuuuu! end Dienstag, 16. Oktober 12

Slide 29

Slide 29 text

if request.version < 2 fffffffffuuuuuuuuu! end Dienstag, 16. Oktober 12

Slide 30

Slide 30 text

Reasons for versioning Dienstag, 16. Oktober 12

Slide 31

Slide 31 text

Data structure changes Dienstag, 16. Oktober 12

Slide 32

Slide 32 text

additions: good subtractions: bad Dienstag, 16. Oktober 12

Slide 33

Slide 33 text

Different auth mechanism Dienstag, 16. Oktober 12

Slide 34

Slide 34 text

Support both... Dienstag, 16. Oktober 12

Slide 35

Slide 35 text

URL changes Dienstag, 16. Oktober 12

Slide 36

Slide 36 text

A-Ha! Dienstag, 16. Oktober 12

Slide 37

Slide 37 text

Expose one endpoint Dienstag, 16. Oktober 12

Slide 38

Slide 38 text

Use Hypermedia to reference other urls Dienstag, 16. Oktober 12

Slide 39

Slide 39 text

Real World Dienstag, 16. Oktober 12

Slide 40

Slide 40 text

API iPhone App Android App Mobile Web Desktop App Mashups Dienstag, 16. Oktober 12

Slide 41

Slide 41 text

Shitty connections, expensive data plans, low memory Dienstag, 16. Oktober 12

Slide 42

Slide 42 text

Aggregations Dienstag, 16. Oktober 12

Slide 43

Slide 43 text

Optimisations for different clients Dienstag, 16. Oktober 12

Slide 44

Slide 44 text

Suggestion Dienstag, 16. Oktober 12

Slide 45

Slide 45 text

Have a "REST" api Dienstag, 16. Oktober 12

Slide 46

Slide 46 text

http://stateless.co/hal_speciﬁcation.html Dienstag, 16. Oktober 12

Slide 47

Slide 47 text

Build APIs on top of APIs Dienstag, 16. Oktober 12

Slide 48

Slide 48 text

Authentication Dienstag, 16. Oktober 12

Slide 49

Slide 49 text

Internal/ External? Dienstag, 16. Oktober 12

Slide 50

Slide 50 text

Javascript-App? Dienstag, 16. Oktober 12

Slide 51

Slide 51 text

Session-Based Dienstag, 16. Oktober 12

Slide 52

Slide 52 text

External? Dienstag, 16. Oktober 12

Slide 53

Slide 53 text

User based? Dienstag, 16. Oktober 12

Slide 54

Slide 54 text

SSL+Basic Auth Dienstag, 16. Oktober 12

Slide 55

Slide 55 text

OAuth2 Dienstag, 16. Oktober 12

Slide 56

Slide 56 text

Dienstag, 16. Oktober 12

Slide 57

Slide 57 text

SSL! Dienstag, 16. Oktober 12

Slide 58

Slide 58 text

http://github.com/songkick/oauth2-provider Dienstag, 16. Oktober 12

Slide 59

Slide 59 text

Auth inception Dienstag, 16. Oktober 12

Slide 60

Slide 60 text

App based? Dienstag, 16. Oktober 12

Slide 61

Slide 61 text

API_KEY API_SECRET Dienstag, 16. Oktober 12

Slide 62

Slide 62 text

Using authlogic? Dienstag, 16. Oktober 12

Slide 63

Slide 63 text

http://github.com/phurni/authlogic_api Dienstag, 16. Oktober 12

Slide 64

Slide 64 text

Building Dienstag, 16. Oktober 12

Slide 65

Slide 65 text

https://github.com/halfbyte/bookrack/ Dienstag, 16. Oktober 12

Slide 66

Slide 66 text

✓ Build an API Dienstag, 16. Oktober 12

Slide 67

Slide 67 text

POST /books.json GET /books.json GET /books/1.json PUT /books/1.json DELETE /books/1.json Dienstag, 16. Oktober 12

Slide 68

Slide 68 text

$ rails g scaffold Book ... Dienstag, 16. Oktober 12

Slide 69

Slide 69 text

def index @books = Book.all respond_to do |format| format.html # index.html.erb format.json { render json: @books } end end Dienstag, 16. Oktober 12

Slide 70

Slide 70 text

respond_to :html, :json def index @books = Book.all respond_with @books end Dienstag, 16. Oktober 12

Slide 71

Slide 71 text

[ { "author": "Jan Krutisch", "created_at": "2012-10-14T16:29:17Z", "description": "A funny story", "id": 1, "isbn": "", "title": "The Website is Down", "updated_at": "2012-10-14T16:29:17Z" } ] Dienstag, 16. Oktober 12

Slide 72

Slide 72 text

Customize output Dienstag, 16. Oktober 12

Slide 73

Slide 73 text

def index @books = Book.all respond_with @books.map{|b| { id: b.id, title: b.title, author: b.author, created_at: b.created_at }} end Dienstag, 16. Oktober 12

Slide 74

Slide 74 text

Dienstag, 16. Oktober 12

Slide 75

Slide 75 text

jBuilder Dienstag, 16. Oktober 12

Slide 76

Slide 76 text

Dienstag, 16. Oktober 12

Slide 77

Slide 77 text

Dienstag, 16. Oktober 12

Slide 78

Slide 78 text

gem "jbuilder" Dienstag, 16. Oktober 12

Slide 79

Slide 79 text

books.json.jbuilder Dienstag, 16. Oktober 12

Slide 80

Slide 80 text

# index.json.jbuilder json.(@books) do |json, book| json.partial! book end Dienstag, 16. Oktober 12

Slide 81

Slide 81 text

_book.json.jbuilder Dienstag, 16. Oktober 12

Slide 82

Slide 82 text

# _book.json.jbuilder json.(book, :id, :title, :author) Dienstag, 16. Oktober 12

Slide 83

Slide 83 text

Associations Dienstag, 16. Oktober 12

Slide 84

Slide 84 text

# _book.json.jbuilder json.(book, :id, :title, :author) json.comments(book.comments) do |json, comment| json.partial! comment end Dienstag, 16. Oktober 12

Slide 85

Slide 85 text

# comments/_comment.json.jbuilder json.(comment, :text, :name) Dienstag, 16. Oktober 12

Slide 86

Slide 86 text

[ { "book": { "id": 1, "title": "The Website is down", "author": "Jan Krutisch", "comments": [ { "text": "A shitty comment", "name": "Jan" }, { "text": "Another shitty comment", "name": "Felix Baumgartner" }, { "text": "I disagree!", "name": "Troll" } ] } } ] Dienstag, 16. Oktober 12

Slide 87

Slide 87 text

+ Kind of the right place + Full view infrastructure available + Easy to use Dienstag, 16. Oktober 12

Slide 88

Slide 88 text

I hated .builder Dienstag, 16. Oktober 12

Slide 89

Slide 89 text

Data structures vs. Content representation Dienstag, 16. Oktober 12

Slide 90

Slide 90 text

ActiveModel serializers Dienstag, 16. Oktober 12

Slide 91

Slide 91 text

gem "active_model_serializers" Dienstag, 16. Oktober 12

Slide 92

Slide 92 text

gem "active_model_serializers" Dienstag, 16. Oktober 12

Slide 93

Slide 93 text

gem "active_model_serializers", :git => "git://github.com/josevalim/active_model_serializers.git" Dienstag, 16. Oktober 12

Slide 94

Slide 94 text

serializers/ book_serializer.rb Dienstag, 16. Oktober 12

Slide 95

Slide 95 text

class BookSerializer < ActiveModel::Serializer attributes :id, :author, :title end Dienstag, 16. Oktober 12

Slide 96

Slide 96 text

{ "books": [ { "id": 1, "author": "Jan Krutisch", "title": "The Website is Down" } ] } Dienstag, 16. Oktober 12

Slide 97

Slide 97 text

ActiveModel::ArraySerializer.root = false Dienstag, 16. Oktober 12

Slide 98

Slide 98 text

[ { "id": 1, "author": "Jan Krutisch", "title": "The Website is Down" } ] Dienstag, 16. Oktober 12

Slide 99

Slide 99 text

Associations Dienstag, 16. Oktober 12

Slide 100

Slide 100 text

class BookSerializer < ActiveModel::Serializer attributes :id, :author, :title has_many :comments end Dienstag, 16. Oktober 12

Slide 101

Slide 101 text

(CommentSerializer) Dienstag, 16. Oktober 12

Slide 102

Slide 102 text

+ mostly declarative, with fallbacks + no view code to mangle data structures - no helpers except URL helpers Dienstag, 16. Oktober 12

Slide 103

Slide 103 text

RABL Dienstag, 16. Oktober 12

Slide 104

Slide 104 text

gem "rabl" Dienstag, 16. Oktober 12

Slide 105

Slide 105 text

# books/index.json.rabl collection @books attributes :id, :title, :author Dienstag, 16. Oktober 12

Slide 106

Slide 106 text

Associations Dienstag, 16. Oktober 12

Slide 107

Slide 107 text

# books/index.json.rabl collection @books attributes :id, :title, :author child :comments do attributes :text, :name end Dienstag, 16. Oktober 12

Slide 108

Slide 108 text

embed? glue? wat? Dienstag, 16. Oktober 12

Slide 109

Slide 109 text

+ Mosty declarative + Full view infrastructure - Kinda ugly, kinda weird - (It get's weirder the more you look) Dienstag, 16. Oktober 12

Slide 110

Slide 110 text

ROAR Dienstag, 16. Oktober 12

Slide 111

Slide 111 text

Almost like serializers Dienstag, 16. Oktober 12

Slide 112

Slide 112 text

Both Serializing and Deserializing Dienstag, 16. Oktober 12

Slide 113

Slide 113 text

HAL implementation Dienstag, 16. Oktober 12

Slide 114

Slide 114 text

No examples Dienstag, 16. Oktober 12

Slide 115

Slide 115 text

Testing Dienstag, 16. Oktober 12

Slide 116

Slide 116 text

Assumption Dienstag, 16. Oktober 12

Slide 117

Slide 117 text

Test::Unit Dienstag, 16. Oktober 12

Slide 118

Slide 118 text

1. Unit testing Dienstag, 16. Oktober 12

Slide 119

Slide 119 text

It's understood Dienstag, 16. Oktober 12

Slide 120

Slide 120 text

2. Integration testing Dienstag, 16. Oktober 12

Slide 121

Slide 121 text

Rails Dienstag, 16. Oktober 12

Slide 122

Slide 122 text

require 'test_helper' require 'json' class BooksTest < ActionDispatch::IntegrationTest test "books.json should return valid json" do get "/books.json" body = JSON.parse(response.body) assert_not_nil body assert_equal 200, status end end Dienstag, 16. Oktober 12

Slide 123

Slide 123 text

Rack::Test Dienstag, 16. Oktober 12

Slide 124

Slide 124 text

require 'test_helper' require 'json' class BooksRackTest < ActiveSupport::TestCase include Rack::Test::Methods def app; Rails.application; end test "should return valid json" do get '/books.json' assert last_response.ok? body = JSON.parse(last_response.body) assert_not_nil body end end Dienstag, 16. Oktober 12

Slide 125

Slide 125 text

Slide 126

Slide 126 text

Why? Dienstag, 16. Oktober 12

Slide 127

Slide 127 text

Capybara? Dienstag, 16. Oktober 12

Slide 128

Slide 128 text

Cucumber? Dienstag, 16. Oktober 12

Slide 129

Slide 129 text

What to test? Dienstag, 16. Oktober 12

Slide 130

Slide 130 text

Response Codes Dienstag, 16. Oktober 12

Slide 131

Slide 131 text

Valid JSON Dienstag, 16. Oktober 12

Slide 132

Slide 132 text

JSON structure Dienstag, 16. Oktober 12

Slide 133

Slide 133 text

(keep it simple) Dienstag, 16. Oktober 12

Slide 134

Slide 134 text

ETags, Cache Headers Dienstag, 16. Oktober 12

Slide 135

Slide 135 text

Workﬂows Dienstag, 16. Oktober 12

Slide 136

Slide 136 text

Interactions Dienstag, 16. Oktober 12

Slide 137

Slide 137 text

3. External testing Dienstag, 16. Oktober 12

Slide 138

Slide 138 text

External Client Dienstag, 16. Oktober 12

Slide 139

Slide 139 text

(Client Lib?) Dienstag, 16. Oktober 12

Slide 140

Slide 140 text

Test script Dienstag, 16. Oktober 12

Slide 141

Slide 141 text

namespace :api_tests do desc "Testing the /books endpoint" task :books do require 'rest_client' require 'json' json = JSON.parse( RestClient.get('http://localhost:3000/books.json') ) exit(1) if (json.nil?) end end Dienstag, 16. Oktober 12

Slide 142

Slide 142 text

Testing >>> Monitoring Dienstag, 16. Oktober 12

Slide 143

Slide 143 text

Q & A Dienstag, 16. Oktober 12

Slide 144

Slide 144 text

Thanks! • http://jan.krutisch.de/ • http://twitter.com/halfbyte • https://alpha.app.net/halfbyte • https://github.com/halfbyte • http://thesinglepageapp.com Dienstag, 16. Oktober 12

Slide 145

Slide 145 text

Thanks! • http://jan.krutisch.de/ • http://twitter.com/halfbyte • https://alpha.app.net/halfbyte • https://github.com/halfbyte • http://thesinglepageapp.com (shameless plug) Dienstag, 16. Oktober 12