Class: Tankard::Api::Beers

Inherits:

Object

• Object
• Tankard::Api::Beers

Includes:

Enumerable, Request::Get, Utils::PageFinders

Defined in:

lib/tankard/api/beers.rb

Overview

Access for the /beers route on brewerydb

See Also:

• http://www.brewerydb.com/developers/docs-endpoint/beer_index

Author:

• Matthew Shafer

Instance Method Summary

• #each {|hash| ... } ⇒ Object

  Calls the given block once for each beer.

• #initialize(request, options = {}) ⇒ Tankard::Api::Beers constructor

  Initializes a new object.

• #name(beer_name) ⇒ self

  Beer name to query with.

• #page(number) ⇒ self

  Page number to request.

• #params(options = {}) ⇒ self

  Additional parameters to send with the request.

Constructor Details

#initialize(request, options = {}) ⇒ Tankard::Api::Beers

Initializes a new object

Parameters:

• request (Tankard::Request)
• options (Hash) (defaults to: {})

# File 'lib/tankard/api/beers.rb', line 21

def initialize(request, options = {})
  @http_client = request
  @http_request_parameters = Hashie::Mash.new(options)
end

Instance Method Details

#each {|hash| ... } ⇒ Object

Calls the given block once for each beer

Yield Parameters:

• hash (Hash) —

  containing individual beer information

Raises:

• (Tankard::Error::ApiKeyUnauthorized) —

  when an api key is not valid

• (Tankard::Error::InvalidResponse) —

  when no data is returned fron the api

• (Tankard::Error::HttpError) —

  when a status other than 200 or 401 is returned

• (Tankard::Error::LoadError) —

  when multi json is unable to decode json

# File 'lib/tankard/api/beers.rb', line 26

#name(beer_name) ⇒ self

Beer name to query with

Parameters:

• beer_name (String)

Returns:

• (self) —

  returns itself

# File 'lib/tankard/api/beers.rb', line 39

def name(beer_name)
  @http_request_parameters.name = beer_name
  self
end

#page(number) ⇒ self

Page number to request

Parameters:

• number (Integer)

Returns:

• (self) —

  returns itself

# File 'lib/tankard/api/beers.rb', line 48

def page(number)
  @http_request_parameters.p = number
  self
end

#params(options = {}) ⇒ self

Additional parameters to send with the request

Parameters:

• options (Hash) (defaults to: {})

Returns:

• (self) —

  returns itself

# File 'lib/tankard/api/beers.rb', line 57

def params(options = {})
  options.each_pair do |key, value|
    @http_request_parameters[key] = value
  end
  self
end