goliath/doc/Goliath/API.html at gh-pages · rcreasey/goliath

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Class: Goliath::API</title>

relpath = '..';

if (relpath != '') relpath += '/';

</script>

</head>

<body>

if (window.top.frames.main) document.body.className = 'frames';

</script>

<a href="../_index.html">Index (A)</a> »

<span class='title'><span class='object_link'><a href="../Goliath.html" title="Goliath (module)">Goliath</a></span></span>

<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>

</div>

<a id="class_list_link" href="#">Class List</a>

<a id="method_list_link" href="#">Method List</a>

</div>

</div>

<div id="content"><h1>Class: Goliath::API

</h1>

<dt class="r1">Inherits:</dt>

<span class="inheritName">Object</span>

<li>Object</li>

<li class="next">Goliath::API</li>

</ul>

</dd>

<dt class="r2 last">Defined in:</dt>

<dd class="r2 last">lib/goliath/api.rb</dd>

</dl>

<h2>Overview</h2><div class="docstring">

<p>

All Goliath APIs subclass Goliath::API. All subclasses <em>must</em>

override the <span class='object_link'><a href="#response-instance_method" title="Goliath::API#response (method)">#response</a></span> method.

</p>

</div>

<h3>Examples:</h3>

<pre class="example code"><span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>goliath</span><span class='tstring_end'>'</span></span>

<span class='kw'>class</span> <span class='const'>HelloWorld</span> <span class='op'><</span> <span class='const'>Goliath</span><span class='op'>::</span><span class='const'>API</span>

<span class='kw'>def</span> <span class='id response'>response</span><span class='lparen'>(</span><span class='id env'>env</span><span class='rparen'>)</span>

<span class='lbracket'>[</span><span class='int'>200</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>hello world</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>

</div>

<h2>

Class Method Summary

<small>(<a href="#" class="summary_toggle">collapse</a>)</small>

</h2>

<a href="#map-class_method" title="map (class method)">+ (Object) <strong>map</strong>(name, &block) </a>

</span>

Specify a router map to be used by the API.

</p>

</div></span>

</li>

<a href="#maps-class_method" title="maps (class method)">+ (Array) <strong>maps</strong> </a>

</span>

Returns the router maps configured for the API.

</p>

</div></span>

</li>

<a href="#middlewares-class_method" title="middlewares (class method)">+ (Array) <strong>middlewares</strong> </a>

</span>

Retrieves the middlewares defined by this API server.

</p>

</div></span>

</li>

<a href="#plugin-class_method" title="plugin (class method)">+ (Object) <strong>plugin</strong>(name, *args) </a>

</span>

Specify a plugin to be used by the API.

</p>

</div></span>

</li>

<a href="#plugins-class_method" title="plugins (class method)">+ (Array) <strong>plugins</strong> </a>

</span>

Returns the plugins configured for this API.

</p>

</div></span>

</li>

<a href="#use-class_method" title="use (class method)">+ (Object) <strong>use</strong>(name, args = nil, &block) </a>

</span>

Specify a middleware to be used by the API.

</p>

</div></span>

</li>

</ul>

<h2>

Instance Method Summary

<small>(<a href="#" class="summary_toggle">collapse</a>)</small>

</h2>

<a href="#call-instance_method" title="#call (instance method)">- (Goliath::Connection::AsyncResponse) <strong>call</strong>(env) </a>

</span>

<span class='object_link'><a href="#call-instance_method" title="Goliath::API#call (method)">#call</a></span> is executed automatically by the middleware chain and will setup

the environment for the <span class='object_link'><a href="#response-instance_method" title="Goliath::API#response (method)">#response</a></span> method to execute.

</p>

</div></span>

</li>

<a href="#env-instance_method" title="#env (instance method)">- (Goliath::Env) <strong>env</strong> </a>

</span>

Accessor for the current env object.

</p>

</div></span>

</li>

<a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(name, *args, &blk) </a>

</span>

The API will proxy missing calls to the env object if possible.

</p>

</div></span>

</li>

<a href="#options_parser-instance_method" title="#options_parser (instance method)">- (Object) <strong>options_parser</strong>(opts, options) </a>

</span>

Default stub method to add options into the option parser.

</p>

</div></span>

</li>

<a href="#response-instance_method" title="#response (instance method)">- (Array) <strong>response</strong>(env) </a>

</span>

Response is the main implementation method for Goliath APIs.

</p>

</div></span>

</li>

</ul>

<h2>Dynamic Method Handling</h2>

This class handles dynamic methods through the <tt>method_missing</tt> method

</p>

- (<tt>Object</tt>) <strong>method_missing</strong>(name, *args, &blk)

</p><div class="docstring">

<p>

The API will proxy missing calls to the env object if possible.

</p>

<p>

The two entries in this example are equivalent as long as you are not in a

streaming server.

</p>

</div>

<h3>Examples:</h3>

<pre class="example code"><span class='id logger'>logger</span><span class='period'>.</span><span class='id info'>info</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Hello</span><span class='tstring_end'>"</span></span>

<span class='id env'>env</span><span class='period'>.</span><span class='id logger'>logger</span><span class='period'>.</span><span class='id info'>info</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Hello</span><span class='tstring_end'>"</span></span></pre>

</div>

</div><table class="source_code">

<tr>

<td>

122

123

124

125

126

127

128

129</pre>

</td>

<td>

<pre class="code"><span class="info file"># File 'lib/goliath/api.rb', line 122</span>

<span class='kw'>def</span> <span class='id method_missing'>method_missing</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id blk'>blk</span><span class='rparen'>)</span>

<span class='kw'>if</span> <span class='id env'>env</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id name'>name</span><span class='rparen'>)</span>

<span class='kw'>super</span><span class='lparen'>(</span><span class='id name'>name</span><span class='period'>.</span><span class='id to_sym'>to_sym</span><span class='comma'>,</span> <span class='op'>*</span><span class='id args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id blk'>blk</span><span class='rparen'>)</span>

</td>

</tr>

</table>

</div>

<h2>Class Method Details</h2>

+ (<tt>Object</tt>) <strong>map</strong>(name, &block)

</p><div class="docstring">

<p>

Specify a router map to be used by the API

</p>

</div>

<h3>Examples:</h3>

<pre class="example code"><span class='id map'>map</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/version</span><span class='tstring_end'>'</span></span> <span class='kw'>do</span>

<span class='id run'>run</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id new'>new</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id env'>env</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='int'>200</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>text/html</span><span class='tstring_end'>"</span></span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Version 0.1</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>

</div>

<h3>Parameters:</h3>

<li>

<span class='type'>(<tt>String</tt>)</span>

—

The URL path to map

</p>

</div>

</li>

<li>

<span class='name'>block</span>

—

The code to execute

</p>

</div>

</li>

</ul>

</div><table class="source_code">

<tr>

<td>

88</pre>

</td>

<td>

<pre class="code"><span class="info file"># File 'lib/goliath/api.rb', line 86</span>

<span class='kw'>def</span> <span class='id map'>map</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='op'>&</span><span class='id block'>block</span><span class='rparen'>)</span>

<span class='id maps'>maps</span><span class='period'>.</span><span class='id push'>push</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id name'>name</span><span class='comma'>,</span> <span class='id block'>block</span><span class='rbracket'>]</span><span class='rparen'>)</span>

</td>

</tr>

</table>

</div>

+ (<tt>Array</tt>) <strong>maps</strong>

</p><div class="docstring">

<p>

Returns the router maps configured for the API

</p>

</div>

<h3>Returns:</h3>

<li>

<span class='type'>(<tt>Array</tt>)</span>

—

array contains [path, block]

</p>

</div>

</li>

</ul>

</div><table class="source_code">

<tr>

<td>

75</pre>

</td>

<td>

<pre class="code"><span class="info file"># File 'lib/goliath/api.rb', line 73</span>

</td>

</tr>

</table>

</div>

+ (<tt>Array</tt>) <strong>middlewares</strong>

</p><div class="docstring">

<p>

Retrieves the middlewares defined by this API server

</p>

</div>

<h3>Returns:</h3>

<li>

<span class='type'>(<tt>Array</tt>)</span>

—

array contains [middleware class, args, block]

</p>

</div>

</li>

</ul>

</div><table class="source_code">

<tr>

<td>

33</pre>

</td>

<td>

<pre class="code"><span class="info file"># File 'lib/goliath/api.rb', line 22</span>

<span class='kw'>def</span> <span class='id middlewares'>middlewares</span>

<span class='ivar'>@middlewares</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>

<span class='ivar'>@middlewares</span><span class='period'>.</span><span class='id unshift'>unshift</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='op'>::</span><span class='const'>Goliath</span><span class='op'>::</span><span class='const'>Rack</span><span class='op'>::</span><span class='const'>DefaultResponseFormat</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span><span class='rparen'>)</span>

<span class='ivar'>@middlewares</span><span class='period'>.</span><span class='id unshift'>unshift</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='op'>::</span><span class='const'>Rack</span><span class='op'>::</span><span class='const'>ContentLength</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span><span class='rparen'>)</span>

<span class='kw'>if</span> <span class='const'>Goliath</span><span class='period'>.</span><span class='id dev?'>dev?</span>

<span class='id reloader'>reloader</span> <span class='op'>=</span> <span class='ivar'>@middlewares</span><span class='period'>.</span><span class='id detect'>detect</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id mw'>mw</span><span class='op'>|</span> <span class='id mw'>mw</span><span class='period'>.</span><span class='id first'>first</span> <span class='op'>==</span> <span class='op'>::</span><span class='const'>Rack</span><span class='op'>::</span><span class='const'>Reloader</span><span class='rbrace'>}</span>

<span class='ivar'>@middlewares</span><span class='period'>.</span><span class='id unshift'>unshift</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='op'>::</span><span class='const'>Rack</span><span class='op'>::</span><span class='const'>Reloader</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id reloader'>reloader</span>

<span class='ivar'>@middlewares</span>

</td>

</tr>

</table>

</div>

+ (<tt>Object</tt>) <strong>plugin</strong>(name, *args)

</p><div class="docstring">

<p>

Specify a plugin to be used by the API

</p>

</div>

<h3>Examples:</h3>

<pre class="example code"><span class='id plugin'>plugin</span> <span class='const'>Goliath</span><span class='op'>::</span><span class='const'>Plugin</span><span class='op'>::</span><span class='const'>Latency</span></pre>

</div>

<h3>Parameters:</h3>

<li>

<span class='type'>(<tt>Class</tt>)</span>

—

The plugin class to use

</p>

</div>

</li>

<li>

—

The arguments to the plugin

</p>

</div>

</li>

</ul>

</div><table class="source_code">

<tr>

<td>

68</pre>

</td>

<td>

<pre class="code"><span class="info file"># File 'lib/goliath/api.rb', line 66</span>

<span class='kw'>def</span> <span class='id plugin'>plugin</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id args'>args</span><span class='rparen'>)</span>

<span class='id plugins'>plugins</span><span class='period'>.</span><span class='id push'>push</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id name'>name</span><span class='comma'>,</span> <span class='id args'>args</span><span class='rbracket'>]</span><span class='rparen'>)</span>

</td>

</tr>

</table>

</div>

+ (<tt>Array</tt>) <strong>plugins</strong>

</p><div class="docstring">

<p>

Returns the plugins configured for this API

</p>

</div>

<h3>Returns:</h3>

<li>

<span class='type'>(<tt>Array</tt>)</span>

—

array contains [plugin name, args]

</p>

</div>

</li>

</ul>

</div><table class="source_code">

<tr>

<td>

57</pre>

</td>

<td>

<pre class="code"><span class="info file"># File 'lib/goliath/api.rb', line 55</span>

<span class='kw'>def</span> <span class='id plugins'>plugins</span>

<span class='ivar'>@plugins</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>

</td>

</tr>

</table>

</div>

+ (<tt>Object</tt>) <strong>use</strong>(name, args = nil, &block)

</p><div class="docstring">

<p>

Specify a middleware to be used by the API

</p>

</div>

<h3>Examples:</h3>

<pre class="example code"><span class='id use'>use</span> <span class='const'>Goliath</span><span class='op'>::</span><span class='const'>Rack</span><span class='op'>::</span><span class='const'>Validation</span><span class='op'>::</span><span class='const'>RequiredParam</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='symbol'>:key</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echo</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span>

<span class='id use'>use</span> <span class='op'>::</span><span class='const'>Rack</span><span class='op'>::</span><span class='const'>Rewrite</span> <span class='kw'>do</span>

<span class='id rewrite'>rewrite</span> <span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>^(.*?)\??gziped=(.*)$</span><span class='regexp_end'>}</span></span><span class='comma'>,</span> <span class='id lambda'>lambda</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id match'>match</span><span class='comma'>,</span> <span class='id env'>env</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id match'>match</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>?echo=</span><span class='embexpr_beg'>#{</span><span class='id match'>match</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span>

</div>

<h3>Parameters:</h3>

<li>

<span class='type'>(<tt>Class</tt>)</span>

—

The middleware class to use

</p>

</div>

</li>

<li>

<em class="default">(defaults to: <tt>nil</tt>)</em>

—

Any arguments to pass to the middeware

</p>

</div>

</li>

<li>

<span class='name'>block</span>

—

A block to pass to the middleware

</p>

</div>

</li>

</ul>

</div><table class="source_code">

<tr>

<td>

50</pre>

</td>

<td>

<pre class="code"><span class="info file"># File 'lib/goliath/api.rb', line 47</span>

<span class='kw'>def</span> <span class='id use'>use</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='id args'>args</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&</span><span class='id block'>block</span><span class='rparen'>)</span>

<span class='ivar'>@middlewares</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>

<span class='ivar'>@middlewares</span> <span class='op'><<</span> <span class='lbracket'>[</span><span class='id name'>name</span><span class='comma'>,</span> <span class='id args'>args</span><span class='comma'>,</span> <span class='id block'>block</span><span class='rbracket'>]</span>

</td>

</tr>

</table>

</div>

<h2>Instance Method Details</h2>

- (<tt><span class='object_link'><a href="Connection.html#AsyncResponse-constant" title="Goliath::Connection::AsyncResponse (constant)">Goliath::Connection::AsyncResponse</a></span></tt>) <strong>call</strong>(env)

</p><div class="docstring">

<p>

<span class='object_link'><a href="#call-instance_method" title="Goliath::API#call (method)">#call</a></span> is executed automatically by the middleware chain and will setup

the environment for the <span class='object_link'><a href="#response-instance_method" title="Goliath::API#response (method)">#response</a></span> method to execute. This includes

setting up a new Fiber, handing any execptions thrown from the API and

executing the appropriate callback method for the API.

</p>

</div>

<h3>Parameters:</h3>

<li>

<span class='type'>(<tt><span class='object_link'><a href="Env.html" title="Goliath::Env (class)">Goliath::Env</a></span></tt>)</span>

—

The request environment

</p>

</div>

</li>

</ul>

<h3>Returns:</h3>

<li>

<span class='type'>(<tt><span class='object_link'><a href="Connection.html#AsyncResponse-constant" title="Goliath::Connection::AsyncResponse (constant)">Goliath::Connection::AsyncResponse</a></span></tt>)</span>

View remainder of file in raw view

FilesExpand file tree

API.html

Latest commit

History

API.html

File metadata and controls