Module: TheCity::API::Needs

Includes:

Utils

Included in:

Client

Defined in:

lib/the_city/api/needs.rb

Instance Method Summary

• #need(*args) ⇒ TheCity::Need

  Returns a need by id.

• #post_need(options) ⇒ TheCity::Need

  Posts a need to The City.

Instance Method Details

#need(id) ⇒ TheCity::Need #need(id, options = {}) ⇒ TheCity::Need

Returns a need by id

Overloads:

• #need(id) ⇒ TheCity::Need

  Parameters:

  • id (Integer) —

    The id of the need.

• #need(id, options = {}) ⇒ TheCity::Need

  Parameters:

  • id (Integer) —

    The id of the need.

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

    A customizable set of options.

  Options Hash (options):

  • :force_download (Boolean) —

    Forces the request to hit the server and flush the cached response

Returns:

• (TheCity::Need)

Raises:

• (TheCity::Error::NotFound) —

  Error raised when the need cannot be found.

See Also:

• https://api.onthecity.org/docs

# File 'lib/the_city/api/needs.rb', line 41

def need(*args)
  @needs ||= {}
  arguments = TheCity::Arguments.new(args)
  nid = args.shift
  @needs[nid] = nil if arguments.options.delete(:force_download)
  @needs[nid] ||= object_from_response(TheCity::Need, :get, "/needs/#{nid}", arguments.options, {:client => self})
end

#post_need(options) ⇒ TheCity::Need

Posts a need to The City

Parameters:

• options (Hash) —

  A customizable set of options.

Options Hash (options):

• :group_id (Integer) —

  The id of the group you will be posting to.

• :title (String) —

  The title of the need.

• :body (String) —

  The body text of the need.

Returns:

• (TheCity::Need)

Raises:

• (Error::ArgumentError)

See Also:

• https://api.onthecity.org/docs

# File 'lib/the_city/api/needs.rb', line 20

def post_need(options)
  raise(Error::ArgumentError, "Must supply a options[:group_id] for the needs's originating group") unless options[:group_id]
  raise(Error::ArgumentError, "Title (options[:title]) required") unless options[:title]
  raise(Error::ArgumentError, "Body (options[:body]) required") unless options[:body]
  gid = options[:group_id] || 0
  object_from_response(TheCity::Need, :post, "/groups/#{gid}/needs/", options, {:client => self})
end