module Croudia::API::Statuses

Public Instance Methods

destroy_status(status, params={}) click to toggle source

Destroy a status

@see developer.croudia.com/docs/12_statuses_destroy @param [String, Integer, Croudia::Status] status Status to delete @param [Hash] params Additional query parameters @option params [String] :include_entities Set false to exclude entities @option params [String] :trim_user Set true to return compact user objects @return [Croudia::Status] Deleted status

# File lib/croudia/api/statuses.rb, line 63
def destroy_status(status, params={})
  status_id = get_id(status)
  resp = post("/statuses/destroy/#{status_id}.json", params)
  Croudia::Status.new(resp)
end
share(id, status={}, params={}) click to toggle source

Share (formerly reply with quote) a status

@see developer.croudia.com/docs/110_statuses_share @overload share(id, status, params={})

@param [String, Integer, Croudia::Status] id Post to share
@param [String] status Status text
@param [Hash] params Additional query parameters
@option params [String] :include_entities Set false to exclude entities
@option params [String] :trim_user Set true to return compact user objects

@overload share(params={})

@param [Hash] params Query parameters
@option params [String, Integer, Croudia::Status] :id Post to share
@option params [String] :status Status text
@option params [String] :include_entities Set false to exclude entities
@option params [String] :trim_user Set true to return compact user objects

@return [Croudia::Status] Posted status

# File lib/croudia/api/statuses.rb, line 113
def share(id, status={}, params={})
  merge_id!(params, id)
  merge_text!(params, status)
  resp = post('/statuses/share.json', params)
  Croudia::Status.new(resp)
end
share_with_media(id, status={}, media={}, params={}) click to toggle source

Share (formerly reply with quote) a status with media

@see developer.croudia.com/docs/111_statuses_share_with_media @note Currently only PNG, JPG, and GIF are supported @overload share_with_media(id, status, media, params={})

@param [String, Integer, Croudia::Status] id Post to share
@param [String] status Status text
@param [File, #to_io] media Image to upload with
@param [Hash] params Additional query parameters
@option params [String] :include_entities Set false to exclude entities
@option params [String] :trim_user Set true to return compact user objects

@overload share_with_media(params={})

@param [Hash] params Query parameters
@option params [String, Integer, Croudia::Status] :id Post to share
@option params [String] :include_entities Set false to exclude entities
@option params [File, #to_io] :media Image to upload with
@option params [String] :status Status text
@option params [String] :trim_user Set true to return compact user objects

@return [Croudia::Status]

# File lib/croudia/api/statuses.rb, line 139
def share_with_media(id, status={}, media={}, params={})
  merge_id!(params, id)
  merge_text!(params, status)
  merge_file!(params, media, :media)
  resp = post('/statuses/share_with_media.json', params)
  Croudia::Status.new(resp)
end
spread(status, params={}) click to toggle source

Spread a status

@see developer.croudia.com/docs/61_statuses_spread @param [String, Integer, Croudia::Status] status Status to spread @param [Hash] params Additional query parameters @option params [String] :include_entities Set false to exclude entities @option params [String] :trim_user Set true to return compact user objects @return [Croudia::Status] My status including spreaded status

# File lib/croudia/api/statuses.rb, line 91
def spread(status, params={})
  status_id = get_id(status)
  resp = post("/statuses/spread/#{status_id}.json", params)
  Croudia::Status.new(resp)
end
status(status, params={}) click to toggle source

Retrieve a status

@see developer.croudia.com/docs/13_statuses_show @param [String, Integer, Croudia::Status] status Status to get @param [Hash] params Additional query parameters @option params [String] :include_entities Set false to exclude entities @option params [String] :trim_user Set true to return compact user objects @return [Croudia::Status]

# File lib/croudia/api/statuses.rb, line 77
def status(status, params={})
  status_id = get_id(status)
  resp = get("/statuses/show/#{status_id}.json", params)
  Croudia::Status.new(resp)
end
update(status, params={}) click to toggle source

Update status

@see developer.croudia.com/docs/11_statuses_update @overload update(status, params={})

@param [String] status Status text
@param [Hash] params Additional query parameters
@option params [String, Integer] :in_reply_to_status_id
@option params [String] :include_entities Set false to exclude entities
@option params [String] :trim_user Set true to return compact user objects

@overload update(params={})

@param [Hash] params Query parameters
@option params [String, Integer] :in_reply_to_status_id
@option params [String] :include_entities Set false to exclude entities
@option params [String] :status Status text
@option params [String] :trim_user Set true to return compact user objects

@return [Croudia::Status] Posted status

# File lib/croudia/api/statuses.rb, line 22
def update(status, params={})
  merge_text!(params, status)

  resp = post('/statuses/update.json', params)
  Croudia::Status.new(resp)
end
update_with_media(status, media={}, params={}) click to toggle source

Update status with media

@see developer.croudia.com/docs/14_statuses_update_with_media @note Currently only PNG, JPG, and GIF are supported @overload update_with_media(status, media, params={})

@param [String] status Status text
@param [File, #to_io] media Image to upload with
@param [Hash] params Additional query parameters
@option params [String, Integer] :in_reply_to_status_id
@option params [String] :include_entities Set false to exclude entities
@option params [String] :trim_user Set true to return compact user objects

@overload update_with_media(params={})

@param [Hash] params Query parameters
@option params [String, Integer] :in_reply_to_status_id
@option params [String] :include_entities Set false to exclude entities
@option params [File, #to_io] :media Image to upload with
@option params [String] :status Status text
@option params [String] :trim_user Set true to return compact user objects

@return [Croudia::Status]

# File lib/croudia/api/statuses.rb, line 48
def update_with_media(status, media={}, params={})
  merge_text!(params, status)
  merge_file!(params, media, :media)
  resp = post('/statuses/update_with_media.json', params)
  Croudia::Status.new(resp)
end