timetree 0.0.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd2bf9fe5f866b70a0d08f66a937091892d8d4f3ab09002887eeab9cb6695158
-  data.tar.gz: d27d7eda7746d390feee7f167226ef444e1ed9a0e837cf9ad4510aa577cba340
+  metadata.gz: 6fd16ab1a54faf7be5a951aa8472e997f791ab3dc1bdb06d1588f0630920c2a1
+  data.tar.gz: 0c2ba91f9b256c5011f053cdf831d35c905486097a6cb832635d25261fe3f77a
 SHA512:
-  metadata.gz: 5d8e892ce5c8a12ca0629cab12f15228a28dc2df3d5d0abce51570c3714838aa4a05da1c96575972e4a0af3197057cf2780380d16e31ec364b58513558de5e2c
-  data.tar.gz: c793202b5743b3818fea43bdc1ca6c2b44483d197098d0191181f5bada1dd27a862f6675fa183d959eee696294ba8e6bb680fef1f8ae9753542409ba43314a3b
+  metadata.gz: 01db118d26095eed595b67747f51cd2203fc767378b1b2c39f5ef4985098bf53ba53a2c60d836717924281b603af09f24700bc9ac3ef1d4b63a0b71495baa932
+  data.tar.gz: 29ff89e03d4d9919fbd981f4b34b0fa2ae0a6df5ca57a61b29a50497fd56b3888739139ebd48c554ac120f5aa9369eb8e3658cefcddad19207ea1b42490a1112

data/.gitignore

@@ -7,4 +7,5 @@
 /spec/reports/
 /tmp/
 
+coverage
 Gemfile.lock

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+# 0.1.4
+
+- updates comments.
+
+# 0.1.3
+
+- refs #7 #9 make the code coverage 100%.
+
+# 0.1.2
+
+- refs #1 fix typo Event#recurrences to recurrence
+- refs #2 add a note for debugging guide on README
+
+# 0.1.1
+
+- set current version on this gem's documentation_uri.
+- fixed typo on README.
+
+# 0.1.0
+
+- did refactor and wrote comments.
+- started to use zeitwerk.
+- wrote README.
+
 # 0.0.1
 
 - Initial release

data/README.md

@@ -1,4 +1,4 @@
-# TimeTree Api Client
+# Simple TimeTree APIs client
 
 [![Gem Version](https://badge.fury.io/rb/timetree.svg)](http://badge.fury.io/rb/timetree)
 
@@ -24,20 +24,76 @@ Or install it yourself as:
 
 ## Usage
 
-The Api client needs access token.
-Set `access_token` to the value you got by above:
+The APIs client needs access token.
+Set a `token` variable to the value you got by above:
 
 ```ruby
-# using configure
+# set token by TimeTree.configure methods.
 TimeTree.configure do |config|
-  config.access_token = '<YOUR_ACCESS_TOKEN>'
+  config.token = '<YOUR_ACCESS_TOKEN>'
 end
 client = TimeTree::Client.new
 
-# using initializer
+# set token by TimeTree::Client initializer.
 client = TimeTree::Client.new('<YOUR_ACCESS_TOKEN>')
 
-# TODO
+# get a current user's information.
+user = client.current_user
+=> #<TimeTree::User id:xxx_u001>
+user.name
+=> "USER Name"
+
+# get current user's calendars.
+cals = client.calendars
+=> [#<TimeTree::Calendar id:xxx_cal001>, #<TimeTree::Calendar id:xxx_cal002>, ...]
+cal = cals.first
+cal.name
+=> "Calendar Name"
+
+# get upcoming events on the calendar.
+evs = cal.upcoming_events
+=> [#<TimeTree::Event id:xxx_ev001>, #<TimeTree::Event id:xxx_ev002>, ...]
+ev = evs.first
+ev.title
+=> "Event Title"
+
+# updates an event.
+ev.title += ' Updated'
+ev.start_at = Time.parse('2020-06-20 09:00 +09:00')
+ev.end_at = Time.parse('2020-06-20 10:00 +09:00')
+ev.update
+=> #<TimeTree::Event id:xxx_ev001>
+
+# creates an event.
+copy_ev = ev.dup
+new_ev = copy_ev.create
+=> #<TimeTree::Event id:xxx_new_ev001>
+
+# deletes an event.
+ev.delete
+=> true
+
+# creates a comment to an event.
+ev.create_comment 'Hi there!'
+=> #<TimeTree::Activity id:xxx_act001>
+
+# handles APIs error.
+begin
+  ev.delete
+  ev.delete # 404 Error occured.
+rescue TimeTree::ApiError => e
+  e
+  => #<TimeTree::ApiError title:Not Found, status:404>
+  e.response
+  => #<Faraday::Response>
+end
+
+# if the log level set :debug, you can get the request/response information.
+TimeTree.configuration.logger.level = :debug
+=> #<TimeTree::Event id:event_id_001_not_found>
+>> client.event 'cal_id_001', 'event_id_001_not_found'
+I, [2020-06-24T10:05:07.294807]  INFO -- : GET https://timetreeapis.com/calendars/cal_id_001/events/event_id_001_not_found?include=creator%2Clabel%2Cattendees
+D, [2020-06-24T10:05:07.562038] DEBUG -- : Response status:404, body:{:type=>"https://developers.timetreeapp.com/en/docs/api#client-failure", :title=>"Not Found", :status=>404, :errors=>"Event not found"}
 ```
 
 ## Contributing

data/lib/timetree.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-Dir[
-  File.join(
-    File.dirname(__FILE__),
-    'timetree',
-    '*'
-  )
-].sort.each do |f|
-  require f
-end
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  'timetree' => 'TimeTree'
+)
+loader.setup
 
+# module for TimeTree apis client
 module TimeTree
+  class Error < StandardError
+  end
   class << self
     def configure
       yield configuration
@@ -20,7 +20,4 @@ module TimeTree
       @configuration ||= Configuration.new
     end
   end
-
-  class Error < StandardError
-  end
 end

data/lib/timetree/activity.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module TimeTree
+  # Model for TimeTree comment.
+  class Activity < BaseModel
+    # @return [String]
+    attr_accessor :content
+    # @return [Time]
+    attr_accessor :updated_at
+    # @return [Time]
+    attr_accessor :created_at
+    # calendar's id.
+    # @return [String]
+    attr_accessor :calendar_id
+    # event's id.
+    # @return [String]
+    attr_accessor :event_id
+
+    TIME_FIELDS = %i[updated_at created_at].freeze
+
+    #
+    # Creates a comment to the associated event.
+    #
+    # @return [TimeTree::Activity]
+    # @raise [TimeTree::Error] if @client is not set.
+    # @raise [TimeTree::Error] if the calendar_id property is not set.
+    # @raise [TimeTree::Error] if the event_id property is not set.
+    # @raise [TimeTree::ApiError] if the http response status will not success.
+    # @since 0.0.1
+    def create
+      check_client
+      @client.create_activity calendar_id, event_id, data_params
+    end
+
+    #
+    # convert to a TimeTree request body format.
+    #
+    # @return [Hash]
+    # @since 0.0.1
+    def data_params
+      {
+        data: { attributes: { content: content } }
+      }
+    end
+  end
+end

data/lib/timetree/api_error.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module TimeTree
+  # TimeTree apis client error object.
+  class ApiError < StandardError
+    # @return [Faraday::Response]
+    attr_reader :response
+    # @return [String]
+    attr_reader :type
+    # @return [String]
+    attr_reader :title
+    # @return [String]
+    attr_reader :errors
+    # @return [Integer]
+    attr_reader :status
+
+    def initialize(response)
+      @response = response
+      @type = response.body[:type]
+      @title = response.body[:title]
+      @errors = response.body[:errors]
+      @status = response.status
+    end
+
+    def inspect
+      "\#<#{self.class}:#{object_id} title:#{@title}, status:#{@status}>"
+    end
+  end
+end

data/lib/timetree/base_model.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module TimeTree
+  # TimeTree base model object.
+  class BaseModel
+    # @return [Array<Hash<String,String>>]
+    attr_accessor :relationships
+    # @return [String]
+    attr_reader :id
+    # @return [String]
+    attr_reader :type
+
+    # @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]
+    # A TimeTree model object that be based on the type.
+    # @raise [TimeTree::Error] if the type property is not set or unknown.
+    # @since 0.0.1
+    def self.to_model(data, included: nil, client: nil)
+      id = data[:id]
+      type = data[:type]
+      raise Error, 'type is required.' if type.nil?
+
+      attributes = data[:attributes] || {}
+      relationships = data[:relationships] || {}
+      params = {
+        id: id,
+        type: type,
+        client: client,
+        attributes: attributes,
+        relationships: relationships,
+        included: included
+      }
+
+      case type
+      when 'user'
+        User.new(**params)
+      when 'label'
+        Label.new(**params)
+      when 'calendar'
+        Calendar.new(**params)
+      when 'event'
+        Event.new(**params)
+      when 'activity'
+        Activity.new(**params)
+      else
+        raise Error, "type '#{type}' is unknown."
+      end
+    end
+
+    def initialize(type:, id: nil, client: nil, attributes: nil, relationships: nil, included: nil)
+      @type = type
+      @id = id
+      @client = client
+      set_attributes attributes
+      set_relationships relationships, included
+    end
+
+    def inspect
+      "\#<#{self.class}:#{object_id} id:#{id}>"
+    end
+
+    private
+
+    def check_client
+      raise Error, '@client is nil.' if @client.nil?
+    end
+
+    def to_model(data)
+      self.class.to_model data, client: @client
+    end
+
+    def set_attributes(attributes)
+      return unless attributes.is_a? Hash
+      return if attributes.empty?
+
+      setter_methods = self.class.instance_methods.select { |method| method.to_s.end_with? '=' }
+      attributes.each do |key, value|
+        setter = "#{key.to_sym}=".to_sym
+        next unless setter_methods.include? setter
+
+        if defined?(self.class::TIME_FIELDS) && self.class::TIME_FIELDS.include?(key)
+          value = Time.parse value
+        end
+        instance_variable_set "@#{key}", value
+      end
+    end
+
+    def set_relationships(relationships, included)
+      return unless relationships.is_a? Hash
+      return if relationships.empty?
+      return unless defined? self.class::RELATIONSHIPS
+      return if self.class::RELATIONSHIPS.empty?
+
+      self.class::RELATIONSHIPS.each do |key|
+        relation = relationships[key]
+        next unless relation
+        next unless relation[:data]
+
+        @relationships ||= {}
+        @relationships[key] = relation[:data]
+      end
+
+      return if included.nil?
+      return unless included.is_a? Array
+      return if included.empty?
+
+      set_relationship_data_if_included(included)
+    end
+
+    def set_relationship_data_if_included(included)
+      @_relation_data_dic = {}
+      included.each do |data|
+        item = to_model(data)
+        next unless item
+
+        @_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]
+
+        @_relation_data_dic[type][id]
+      }
+      @relationships.each do |key, id_data|
+        relation_data = nil
+        if id_data.is_a? Array
+          relation_data = []
+          id_data.each do |d|
+            item = detect_relation_data.call(d[:type], d[:id])
+            relation_data << item if item
+          end
+        elsif id_data.is_a? Hash
+          relation_data = detect_relation_data.call(id_data[:type], id_data[:id])
+        end
+        instance_variable_set "@#{key}", relation_data if relation_data
+      end
+    end
+  end
+end

data/lib/timetree/calendar.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module TimeTree
+  # Model for TimeTree calendar.
+  class Calendar < BaseModel
+    # @return [String]
+    attr_accessor :name
+    # @return [String]
+    attr_accessor :description
+    # @return [String]
+    attr_accessor :color
+    # @return [Integer]
+    attr_accessor :order
+    # @return [String]
+    attr_accessor :image_url
+    # @return [Time]
+    attr_accessor :created_at
+
+    TIME_FIELDS = %i[created_at].freeze
+    RELATIONSHIPS = %i[labels members].freeze
+
+    #
+    # Get the event's information.
+    #
+    # @param event_id [String]
+    # event's id.
+    # @return [TimeTree::Event]
+    # @raise [TimeTree::Error] if @client, @id or the event_id arg is empty.
+    # @raise [TimeTree::ApiError] if the http response status will not success.
+    # @since 0.0.1
+    def event(event_id)
+      check_client
+      @client.event id, event_id
+    end
+
+    #
+    # Get the events' information after a request date.
+    #
+    # @param days [Integer]
+    # The number of days to get.
+    # @param timezone [String]
+    # Timezone.
+    # @return [Array<TimeTree::Event>]
+    # @raise [TimeTree::Error] if @client or @id is empty.
+    # @raise [TimeTree::ApiError] if the http response status will not success.
+    # @since 0.0.1
+    def upcoming_events(days: 7, timezone: 'UTC')
+      check_client
+      @client.upcoming_events id, days: days, timezone: timezone
+    end
+
+    #
+    # Get a calendar's member information.
+    #
+    # @return [Array<TimeTree::User>]
+    # @raise [TimeTree::Error] if @client or @id is empty.
+    # @raise [TimeTree::ApiError] if the http response status will not success.
+    # @since 0.0.1
+    def members
+      return @members if defined? @members
+
+      check_client
+      @members = @client.calendar_members id
+    end
+
+    #
+    # Get a calendar's label information used in event.
+    #
+    # @return [Array<TimeTree::Label>]
+    # @raise [TimeTree::Error] if @client or @id is empty.
+    # @raise [TimeTree::ApiError] if the http response status will not success.
+    # @since 0.0.1
+    def labels
+      return @labels if defined? @labels
+
+      check_client
+      @labels = @client.calendar_labels id
+    end
+  end
+end