timetree 0.3.2 → 1.0.0

data/lib/timetree/configuration.rb

@@ -5,13 +5,20 @@ require 'logger'
 module TimeTree
   # TimeTree apis client configuration.
   class Configuration
-    # @return [String]
-    attr_accessor :token
+    # @return [String] OAuthApp's access token
+    attr_accessor :oauth_app_token
+
+    # @return [String] CalendarApp's app id
+    attr_accessor :calendar_app_application_id
+    # @return [String] CalendarApp's private key content#
+    # e.g. File.read('<YOUR_PATH_TO_PEM_FILE>')
+    attr_accessor :calendar_app_private_key
+
     # @return [Logger]
     attr_accessor :logger
 
     def initialize
-      @logger = Logger.new(STDOUT)
+      @logger = Logger.new $stdout
       @logger.level = :warn
     end
   end

data/lib/timetree/http_command.rb

@@ -25,10 +25,10 @@ module TimeTree
     # @param path [String] String or URI to access.
     # @param body_params [Hash]
     # The request bodythat will eventually be converted to JSON.
-    def post(path, body_params = {})
+    def post(path, body_params = {}, &block)
       @logger.debug "POST #{@host}#{path} body:#{body_params}"
       headers = {'Content-Type' => 'application/json'}
-      res = connection.run_request :post, path, body_params.to_json, headers
+      res = connection.run_request :post, path, body_params.to_json, headers, &block
       @client.update_ratelimit(res)
       @logger.debug "Response status:#{res.status}, body:#{res.body}"
       res

data/lib/timetree/models/activity.rb

@@ -31,7 +31,7 @@ module TimeTree
     # @since 0.0.1
     def create
       check_client
-      @client.create_activity calendar_id, event_id, data_params
+      _create
     end
 
     #
@@ -44,5 +44,15 @@ module TimeTree
         data: {attributes: {content: content}}
       }
     end
+
+  private
+
+    def _create
+      if @client.is_a?(CalendarApp::Client)
+        @client.create_activity(event_id, data_params)
+      else
+        @client.create_activity(calendar_id, event_id, data_params)
+      end
+    end
   end
 end

data/lib/timetree/models/application.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'timetree/models/base_model'
+
+module TimeTree
+  # Model for TimeTree application.
+  class Application < BaseModel
+    # @return [String]
+    attr_accessor :name
+    # @return [String]
+    attr_accessor :description
+    # @return [String]
+    attr_accessor :image_url
+  end
+end

data/lib/timetree/models/base_model.rb

@@ -15,10 +15,10 @@ module TimeTree
     # @param data [Hash]
     # TimeTree apis's response data.
     # @param included [Hash]
-    # @param client [TimeTree::Client]
-    # @return [TimeTree::User, TimeTree::Label, TimeTree::Calendar, TimeTree::Event, TimeTree::Activity]
+    # @param client [TimeTree::OAuthApp::Client, TimeTree::CalendarApp::Client]
+    # @return [TimeTree::User, TimeTree::Label, TimeTree::Calendar, TimeTree::Event, TimeTree::Activity, Hash]
     # A TimeTree model object that be based on the type.
-    # @raise [TimeTree::Error] if the type property is not set or unknown.
+    # @raise [TimeTree::Error] if the type property is not set.
     # @since 0.0.1
     def self.to_model(data, included: nil, client: nil) # rubocop:disable all
       id = data[:id]
@@ -37,18 +37,22 @@ module TimeTree
       }
 
       case type
-      when 'user'
-        User.new(**params)
-      when 'label'
-        Label.new(**params)
+      when 'activity'
+        Activity.new(**params)
+      when 'application'
+        Application.new(**params)
       when 'calendar'
         Calendar.new(**params)
       when 'event'
         Event.new(**params)
-      when 'activity'
-        Activity.new(**params)
+      when 'label'
+        Label.new(**params)
+      when 'user'
+        User.new(**params)
       else
-        raise Error.new("type '#{type}' is unknown.")
+        TimeTree.configuration.logger.warn("type '#{type}' is unknown. id:#{id}")
+        # when unexpected model type, return the 'data' argument.
+        data
       end
     end
 
@@ -114,8 +118,17 @@ module TimeTree
         item = to_model(data)
         next unless item
 
-        @_relation_data_dic[item.type] ||= {}
-        @_relation_data_dic[item.type][item.id] = item
+        if item.is_a? Hash
+          item_id = item[:id]
+          item_type = item[:type]
+        else
+          item_id = item.id
+          item_type = item.type
+        end
+        next unless item_id && item_type
+
+        @_relation_data_dic[item_type] ||= {}
+        @_relation_data_dic[item_type][item_id] = item
       end
       detect_relation_data = lambda { |type, id|
         return unless @_relation_data_dic[type]

data/lib/timetree/models/calendar.rb

@@ -32,7 +32,7 @@ module TimeTree
     # @since 0.0.1
     def event(event_id)
       check_client
-      @client.event id, event_id
+      get_event(event_id)
     end
 
     #
@@ -48,7 +48,7 @@ module TimeTree
     # @since 0.0.1
     def upcoming_events(days: 7, timezone: 'UTC')
       check_client
-      @client.upcoming_events id, days: days, timezone: timezone
+      get_upcoming_event(days, timezone)
     end
 
     #
@@ -62,7 +62,7 @@ module TimeTree
       return @members if defined? @members
 
       check_client
-      @members = @client.calendar_members id
+      @members = get_members
     end
 
     #
@@ -76,7 +76,41 @@ module TimeTree
       return @labels if defined? @labels
 
       check_client
-      @labels = @client.calendar_labels id
+      @labels = get_labels
+    end
+
+  private
+
+    def get_event(event_id)
+      if @client.is_a?(CalendarApp::Client)
+        @client.event(event_id)
+      else
+        @client.event(id, event_id)
+      end
+    end
+
+    def get_upcoming_event(days, timezone)
+      if @client.is_a?(CalendarApp::Client)
+        @client.upcoming_events(days: days, timezone: timezone)
+      else
+        @client.upcoming_events(id, days: days, timezone: timezone)
+      end
+    end
+
+    def get_members
+      if @client.is_a?(CalendarApp::Client)
+        @client.calendar_members
+      else
+        @client.calendar_members(id)
+      end
+    end
+
+    def get_labels
+      if @client.is_a?(CalendarApp::Client)
+        raise Error.new 'CalendarApp does not support label api'
+      else
+        @client.calendar_labels(id)
+      end
     end
   end
 end

data/lib/timetree/models/event.rb

@@ -56,7 +56,7 @@ module TimeTree
     # @since 0.0.1
     def create
       check_client
-      @client.create_event calendar_id, data_params
+      _create_event
     end
 
     #
@@ -68,7 +68,7 @@ module TimeTree
     # @since 0.0.1
     def update
       check_client
-      @client.update_event calendar_id, id, data_params
+      _update_event
     end
 
     #
@@ -80,7 +80,7 @@ module TimeTree
     # @since 0.0.1
     def delete
       check_client
-      @client.delete_event calendar_id, id
+      _delete_event
     end
 
     #
@@ -132,5 +132,29 @@ module TimeTree
         attendees: {data: current_attendees}
       }
     end
+
+    def _create_event
+      if @client.is_a?(CalendarApp::Client)
+        @client.create_event(data_params)
+      else
+        @client.create_event(calendar_id, data_params)
+      end
+    end
+
+    def _update_event
+      if @client.is_a?(CalendarApp::Client)
+        @client.update_event(id, data_params)
+      else
+        @client.update_event(calendar_id, id, data_params)
+      end
+    end
+
+    def _delete_event
+      if @client.is_a?(CalendarApp::Client)
+        @client.delete_event(id)
+      else
+        @client.delete_event(calendar_id, id)
+      end
+    end
   end
 end

data/lib/timetree/oauth_app/client.rb

@@ -0,0 +1,256 @@
+# frozen_string_literal: true
+
+module TimeTree
+  module OAuthApp
+    # TimeTree API OAuthApp client.
+    class Client < BaseClient
+      # @return [String]
+      attr_reader :token
+
+      # @param token [String] a TimeTree's access token.
+      def initialize(token = nil)
+        @token = token || TimeTree.configuration.oauth_app_token
+        check_token
+        @http_cmd = HttpCommand.new(API_HOST, self)
+      end
+
+      #
+      # Get current user information.
+      #
+      # @return [TimeTree::User]
+      # @raise [TimeTree::ApiError] if the http response status will not success.
+      # @since 0.0.1
+      def current_user
+        res = @http_cmd.get '/user'
+        raise ApiError.new(res) if res.status != 200
+
+        to_model res.body[:data]
+      end
+
+      #
+      # 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
+      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 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
+      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
+
+      #
+      # 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
+      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
+      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 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
+      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
+
+      #
+      # Get the events' information after a request date.
+      #
+      # @param cal_id[String] 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
+      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
+
+      #
+      # 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
+      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
+
+      #
+      # 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
+      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
+
+      #
+      # 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
+      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
+
+      #
+      # 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
+      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
+
+      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
+
+    private
+
+      def check_token
+        check_required_property(@token, 'token')
+      end
+
+      def check_calendar_id(value)
+        check_required_property(value, 'calendar_id')
+      end
+    end
+  end
+end