timetree 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a43c7c885e6f0f2e55fdcf9b6c145e13e981fea4fee23dc468f5f16923826c0
-  data.tar.gz: b1dffa32b6a9d80ebca9e6de06a030e43e9d2bfe895bf9ac5ad4fa687d8f3b4a
+  metadata.gz: 6fd16ab1a54faf7be5a951aa8472e997f791ab3dc1bdb06d1588f0630920c2a1
+  data.tar.gz: 0c2ba91f9b256c5011f053cdf831d35c905486097a6cb832635d25261fe3f77a
 SHA512:
-  metadata.gz: be24215ef1f52ccb2b0c8a8ce87f29dc2132e5987ba99533c73017cbc6a669d45dd5d565c1ff3fa1824d66cadeeddaf91f36ccaf6abd1150c755e0f836383e18
-  data.tar.gz: 1eb41d1864cabaf26293102c7a1b288da4e36930bce4599270e9e57e3b00e85a03e1d0bf2296f1d52ba0d26fcc4418ce287fc45a382da63c99c66209840890c3
+  metadata.gz: 01db118d26095eed595b67747f51cd2203fc767378b1b2c39f5ef4985098bf53ba53a2c60d836717924281b603af09f24700bc9ac3ef1d4b63a0b71495baa932
+  data.tar.gz: 29ff89e03d4d9919fbd981f4b34b0fa2ae0a6df5ca57a61b29a50497fd56b3888739139ebd48c554ac120f5aa9369eb8e3658cefcddad19207ea1b42490a1112

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.1.4
+
+- updates comments.
+
 # 0.1.3
 
 - refs #7 #9 make the code coverage 100%.

data/lib/timetree/base_model.rb

@@ -18,7 +18,7 @@ module TimeTree
     # @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.
+    # @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]
@@ -47,6 +47,8 @@ module TimeTree
         Event.new(**params)
       when 'activity'
         Activity.new(**params)
+      else
+        raise Error, "type '#{type}' is unknown."
       end
     end
 

data/lib/timetree/calendar.rb

@@ -25,7 +25,7 @@ module TimeTree
     # @param event_id [String]
     # event's id.
     # @return [TimeTree::Event]
-    # @raise [TimeTree::Error] if @client is not set.
+    # @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)
@@ -41,7 +41,7 @@ module TimeTree
     # @param timezone [String]
     # Timezone.
     # @return [Array<TimeTree::Event>]
-    # @raise [TimeTree::Error] if @client is not set.
+    # @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')
@@ -53,7 +53,7 @@ module TimeTree
     # Get a calendar's member information.
     #
     # @return [Array<TimeTree::User>]
-    # @raise [TimeTree::Error] if @client is not set.
+    # @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
@@ -67,7 +67,7 @@ module TimeTree
     # Get a calendar's label information used in event.
     #
     # @return [Array<TimeTree::Label>]
-    # @raise [TimeTree::Error] if @client is not set.
+    # @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

data/lib/timetree/client.rb

@@ -40,6 +40,7 @@ module TimeTree
     # @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)
@@ -73,6 +74,7 @@ module TimeTree
     #
     # @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)
@@ -88,6 +90,7 @@ module TimeTree
     #
     # @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)
@@ -106,6 +109,8 @@ module TimeTree
     # @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)
@@ -129,6 +134,7 @@ module TimeTree
     # @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)
@@ -152,6 +158,7 @@ module TimeTree
     # @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)
@@ -172,6 +179,8 @@ module TimeTree
     # @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)
@@ -191,6 +200,8 @@ module TimeTree
     # @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)
@@ -210,7 +221,9 @@ module TimeTree
     # @param params [Hash]
     # comment's information specified in TimeTree request body format.
     # @return [TimeTree::Activity]
-    # @raise [TimeTree::ApiError] if the nhttp response status is not success.
+    # @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

data/lib/timetree/event.rb

@@ -49,7 +49,7 @@ module TimeTree
     # Creates an event to the associated calendar.
     #
     # @return [TimeTree::Event]
-    # @raise [TimeTree::Error] if @client is not set.
+    # @raise [TimeTree::Error] if @client or @calendar_id is empty.
     # @raise [TimeTree::ApiError] if the http response status will not success.
     # @since 0.0.1
     def create
@@ -61,8 +61,7 @@ module TimeTree
     # Updates the event.
     #
     # @return [TimeTree::Event]
-    # @raise [TimeTree::Error] if @client is not set.
-    # @raise [TimeTree::Error] if the id property is not set.
+    # @raise [TimeTree::Error] if @client, @calendar_id or @id is empty.
     # @raise [TimeTree::ApiError] if the http response status will not success.
     # @since 0.0.1
     def update
@@ -74,8 +73,7 @@ module TimeTree
     # Deletes the event.
     #
     # @return [true] if the operation succeeded.
-    # @raise [TimeTree::Error] if @client is not set.
-    # @raise [TimeTree::Error] if the id property is not set.
+    # @raise [TimeTree::Error] if @client, @calendar_id or @id is empty.
     # @raise [TimeTree::ApiError] if the http response status will not success.
     # @since 0.0.1
     def delete
@@ -87,15 +85,13 @@ module TimeTree
     # Creates comment to the event.
     #
     # @return [TimeTree::Activity]
-    # @raise [TimeTree::Error] if @client is not set.
+    # @raise [TimeTree::Error] if @client, @calendar_id or @id is empty.
     # @raise [TimeTree::ApiError] if the http response status will not success.
     # @since 0.0.1
     def create_comment(message)
       check_client
       params = { type: 'activity', attributes: { calendar_id: calendar_id, event_id: id, content: message } }
       activity = to_model params
-      return if activity.nil?
-
       activity.create
     end
 

data/lib/timetree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TimeTree
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timetree
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -174,7 +174,7 @@ metadata:
   homepage_uri: https://github.com/koshilife/timetree-api-ruby-client
   source_code_uri: https://github.com/koshilife/timetree-api-ruby-client
   changelog_uri: https://github.com/koshilife/timetree-api-ruby-client/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/timetree/0.1.3
+  documentation_uri: https://www.rubydoc.info/gems/timetree/0.1.4
 post_install_message: 
 rdoc_options: []
 require_paths: