class TimeTree::OAuthApp::Client
Attributes
@return [String]
Public Class Methods
@param token [String] a TimeTree's access token.
# File lib/timetree/oauth_app/client.rb, line 11 def initialize(token = nil) @token = token || TimeTree.configuration.oauth_app_token check_token @http_cmd = HttpCommand.new(API_HOST, self) end
Public Instance Methods
Get a single calendar's information.
@param cal_id [String] calendar's id. @param include_relationships [Array<symbol>] includes association's object in the response. @return [TimeTree::Calendar] @raise [TimeTree::Error] if the cal_id arg is empty. @raise [TimeTree::ApiError] if the http response status will not success. @since 0.0.1
# File lib/timetree/oauth_app/client.rb, line 40 def calendar(cal_id, include_relationships: nil) check_calendar_id cal_id params = relationships_params(include_relationships, Calendar::RELATIONSHIPS) res = @http_cmd.get "/calendars/#{cal_id}", params raise ApiError.new(res) if res.status != 200 to_model(res.body[:data], included: res.body[:included]) end
Get a calendar's label information used in event.
@param cal_id [String] calendar's id. @return [Array<TimeTree::Label>] @raise [TimeTree::Error] if the cal_id arg is empty. @raise [TimeTree::ApiError] if the http response status will not success. @since 0.0.1
# File lib/timetree/oauth_app/client.rb, line 74 def calendar_labels(cal_id) check_calendar_id cal_id res = @http_cmd.get "/calendars/#{cal_id}/labels" raise ApiError.new(res) if res.status != 200 res.body[:data].map { |item| to_model(item) } end
Get a calendar's member information.
@param cal_id [String] calendar's id. @return [Array<TimeTree::User>] @raise [TimeTree::Error] if the cal_id arg is empty. @raise [TimeTree::ApiError] if the http response status will not success. @since 0.0.1
# File lib/timetree/oauth_app/client.rb, line 90 def calendar_members(cal_id) check_calendar_id cal_id res = @http_cmd.get "/calendars/#{cal_id}/members" raise ApiError.new(res) if res.status != 200 res.body[:data].map { |item| to_model item } end
Get calendar list that current user can access.
@param include_relationships [Array<symbol>] includes association's object in the response. @return [Array<TimeTree::Calendar>] @raise [TimeTree::ApiError] if the http response status will not success. @since 0.0.1
# File lib/timetree/oauth_app/client.rb, line 57 def calendars(include_relationships: nil) params = relationships_params(include_relationships, Calendar::RELATIONSHIPS) res = @http_cmd.get '/calendars', params raise ApiError.new(res) if res.status != 200 included = res.body[:included] res.body[:data].map { |item| to_model(item, included: included) } end
Creates comment to an event.
@param cal_id [String] calendar's id. @param event_id [String] event's id. @param params [Hash] comment's information specified in TimeTree
request body format. @return [TimeTree::Activity] @raise [TimeTree::Error] if the cal_id arg is empty. @raise [TimeTree::Error] if the event_id arg is empty. @raise [TimeTree::ApiError] if the http response status is not success. @since 0.0.1
# File lib/timetree/oauth_app/client.rb, line 222 def create_activity(cal_id, event_id, params) check_calendar_id cal_id check_event_id event_id res = @http_cmd.post "/calendars/#{cal_id}/events/#{event_id}/activities", params raise ApiError.new(res) if res.status != 201 activity = to_model res.body[:data] activity.calendar_id = cal_id activity.event_id = event_id activity end
Creates an event to the calendar.
@param cal_id [String] calendar's id. @param params [Hash] TimeTree
request body format. @return [TimeTree::Event] @raise [TimeTree::Error] if the cal_id arg is empty. @raise [TimeTree::ApiError] if the http response status will not success. @since 0.0.1
# File lib/timetree/oauth_app/client.rb, line 158 def create_event(cal_id, params) check_calendar_id cal_id res = @http_cmd.post "/calendars/#{cal_id}/events", params raise ApiError.new(res) if res.status != 201 ev = to_model res.body[:data] ev.calendar_id = cal_id ev end
Get current user information.
@return [TimeTree::User] @raise [TimeTree::ApiError] if the http response status will not success. @since 0.0.1
# File lib/timetree/oauth_app/client.rb, line 23 def current_user res = @http_cmd.get '/user' raise ApiError.new(res) if res.status != 200 to_model res.body[:data] end
Deletes an event.
@param cal_id [String] calendar's id. @param event_id [String] event's id. @return [true] if the operation succeeded. @raise [TimeTree::Error] if the cal_id arg is empty. @raise [TimeTree::Error] if the event_id arg is empty. @raise [TimeTree::ApiError] if the http response status will not success. @since 0.0.1
# File lib/timetree/oauth_app/client.rb, line 201 def delete_event(cal_id, event_id) check_calendar_id cal_id check_event_id event_id res = @http_cmd.delete "/calendars/#{cal_id}/events/#{event_id}" raise ApiError.new(res) if res.status != 204 true end
Get the event's information.
@param cal_id [String] calendar's id. @param event_id [String] event's id. @param include_relationships [Array<symbol>] includes association's object in the response. @return [TimeTree::Event] @raise [TimeTree::Error] if the cal_id arg is empty. @raise [TimeTree::Error] if the event_id arg is empty. @raise [TimeTree::ApiError] if the http response status will not success. @since 0.0.1
# File lib/timetree/oauth_app/client.rb, line 110 def event(cal_id, event_id, include_relationships: nil) check_calendar_id cal_id check_event_id event_id params = relationships_params(include_relationships, Event::RELATIONSHIPS) res = @http_cmd.get "/calendars/#{cal_id}/events/#{event_id}", params raise ApiError.new(res) if res.status != 200 ev = to_model(res.body[:data], included: res.body[:included]) ev.calendar_id = cal_id ev end
# File lib/timetree/oauth_app/client.rb, line 234 def inspect limit_info = nil if defined?(@ratelimit_limit) && @ratelimit_limit limit_info = " ratelimit:#{ratelimit_remaining}/#{ratelimit_limit}" end if defined?(@ratelimit_reset_at) && @ratelimit_reset_at limit_info = "#{limit_info}, reset_at:#{ratelimit_reset_at.strftime('%m/%d %R')}" end "\#<#{self.class}:#{object_id}#{limit_info}>" end
Get the events' information after a request date.
@param cal_id calendar's id. @param days [Integer] The number of days to get. @param timezone [String] Timezone. @param include_relationships [Array<symbol>] includes association's object in the response. @return [Array<TimeTree::Event>] @raise [TimeTree::Error] if the cal_id arg is empty. @raise [TimeTree::ApiError] if the http response status will not success. @since 0.0.1
# File lib/timetree/oauth_app/client.rb, line 134 def upcoming_events(cal_id, days: 7, timezone: 'UTC', include_relationships: nil) check_calendar_id cal_id params = relationships_params(include_relationships, Event::RELATIONSHIPS) params.merge!(days: days, timezone: timezone) res = @http_cmd.get "/calendars/#{cal_id}/upcoming_events", params raise ApiError.new(res) if res.status != 200 included = res.body[:included] res.body[:data].map do |item| ev = to_model(item, included: included) ev.calendar_id = cal_id ev end end
Updates an event.
@param cal_id [String] calendar's id. @param event_id [String] event's id. @param params [Hash] event's information specified in TimeTree
request body format. @return [TimeTree::Event] @raise [TimeTree::Error] if the cal_id arg is empty. @raise [TimeTree::Error] if the event_id arg is empty. @raise [TimeTree::ApiError] if the http response status will not success. @since 0.0.1
# File lib/timetree/oauth_app/client.rb, line 180 def update_event(cal_id, event_id, params) check_calendar_id cal_id check_event_id event_id res = @http_cmd.put "/calendars/#{cal_id}/events/#{event_id}", params raise ApiError.new(res) if res.status != 200 ev = to_model res.body[:data] ev.calendar_id = cal_id ev end
Private Instance Methods
# File lib/timetree/oauth_app/client.rb, line 251 def check_calendar_id(value) check_required_property(value, 'calendar_id') end
# File lib/timetree/oauth_app/client.rb, line 247 def check_token check_required_property(@token, 'token') end