timetree 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de434a07fd2b0d7024c41f1bc6a555a053fe07da002a60b91479a3f239a5bac6
-  data.tar.gz: a6ab608d7d5bceb77e05d97b2243bc804171602d538f29494b3c6796737f7fc1
+  metadata.gz: 1a43c7c885e6f0f2e55fdcf9b6c145e13e981fea4fee23dc468f5f16923826c0
+  data.tar.gz: b1dffa32b6a9d80ebca9e6de06a030e43e9d2bfe895bf9ac5ad4fa687d8f3b4a
 SHA512:
-  metadata.gz: 67ba773c6beef87fb6e23c9e386b6d685ac4317b99516690ca321f3c216df695fa9a5b7a33c979dd142e37cd95d9ab0f400ffb3c421f77ac20339b2ed344495c
-  data.tar.gz: 85957d72ca8df7f9be67cfaa7b962d892add2a3d2c5745efd41d89a0120553628e36c828de5b6b482e57e0cce7a67ce9959df2542222e4217f339a495283997c
+  metadata.gz: be24215ef1f52ccb2b0c8a8ce87f29dc2132e5987ba99533c73017cbc6a669d45dd5d565c1ff3fa1824d66cadeeddaf91f36ccaf6abd1150c755e0f836383e18
+  data.tar.gz: 1eb41d1864cabaf26293102c7a1b288da4e36930bce4599270e9e57e3b00e85a03e1d0bf2296f1d52ba0d26fcc4418ce287fc45a382da63c99c66209840890c3

data/.gitignore

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

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.1.3
+
+- refs #7 #9 make the code coverage 100%.
+
 # 0.1.2
 
 - refs #1 fix typo Event#recurrences to recurrence

data/README.md

@@ -94,8 +94,6 @@ TimeTree.configuration.logger.level = :debug
 >> 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"}
-Traceback (most recent call last):
-TimeTree::ApiError (TimeTree::ApiError)
 ```
 
 ## Contributing

data/lib/timetree/activity.rb

@@ -28,10 +28,7 @@ module TimeTree
     # @raise [TimeTree::ApiError] if the http response status will not success.
     # @since 0.0.1
     def create
-      raise Error, '@client is nil.' if @client.nil?
-      raise Error, 'calendar_id is required.' if calendar_id.nil?
-      raise Error, 'event_id is required.' if event_id.nil?
-
+      check_client
       @client.create_activity calendar_id, event_id, data_params
     end
 

data/lib/timetree/base_model.rb

@@ -50,9 +50,9 @@ module TimeTree
       end
     end
 
-    def initialize(id:, type:, client: nil, attributes: nil, relationships: nil, included: nil)
-      @id = id
+    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
@@ -64,6 +64,10 @@ module TimeTree
 
     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

data/lib/timetree/calendar.rb

@@ -29,8 +29,7 @@ module TimeTree
     # @raise [TimeTree::ApiError] if the http response status will not success.
     # @since 0.0.1
     def event(event_id)
-      raise Error, '@client is nil.' if @client.nil?
-
+      check_client
       @client.event id, event_id
     end
 
@@ -46,37 +45,36 @@ module TimeTree
     # @raise [TimeTree::ApiError] if the http response status will not success.
     # @since 0.0.1
     def upcoming_events(days: 7, timezone: 'UTC')
-      raise Error, '@client is nil.' if @client.nil?
-
+      check_client
       @client.upcoming_events id, days: days, timezone: timezone
     end
 
     #
-    # Get a calendar's label information used in event.
+    # Get a calendar's member information.
     #
-    # @return [Array<TimeTree::Label>]
+    # @return [Array<TimeTree::User>]
     # @raise [TimeTree::Error] if @client is not set.
     # @raise [TimeTree::ApiError] if the http response status will not success.
     # @since 0.0.1
-    def labels
-      return @labels if defined? @labels
-      raise Error, '@client is nil.' if @client.nil?
+    def members
+      return @members if defined? @members
 
-      @labels = @client.calendar_labels id
+      check_client
+      @members = @client.calendar_members id
     end
 
     #
-    # Get a calendar's member information.
+    # Get a calendar's label information used in event.
     #
-    # @return [Array<TimeTree::User>]
+    # @return [Array<TimeTree::Label>]
     # @raise [TimeTree::Error] if @client is not set.
     # @raise [TimeTree::ApiError] if the http response status will not success.
     # @since 0.0.1
-    def members
-      return @members if defined? @members
-      raise Error, '@client is nil.' if @client.nil?
+    def labels
+      return @labels if defined? @labels
 
-      @members = @client.calendar_members id
+      check_client
+      @labels = @client.calendar_labels id
     end
   end
 end

data/lib/timetree/client.rb

@@ -16,8 +16,7 @@ module TimeTree
     # @param token [String] a TimeTree's access token.
     def initialize(token = nil)
       @token = token || TimeTree.configuration.token
-      raise Error, 'token is required.' unless ready_token?
-
+      check_token
       @http_cmd = HttpCommand.new(API_HOST, self)
     end
 
@@ -44,6 +43,7 @@ module TimeTree
     # @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, res if res.status != 200
@@ -76,6 +76,7 @@ module TimeTree
     # @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, res if res.status != 200
 
@@ -90,6 +91,7 @@ module TimeTree
     # @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, res if res.status != 200
 
@@ -107,6 +109,8 @@ module TimeTree
     # @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, res if res.status != 200
@@ -128,6 +132,7 @@ module TimeTree
     # @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
@@ -150,6 +155,7 @@ module TimeTree
     # @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, res if res.status != 201
 
@@ -169,6 +175,8 @@ module TimeTree
     # @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, res if res.status != 200
 
@@ -186,6 +194,8 @@ module TimeTree
     # @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, res if res.status != 204
 
@@ -203,6 +213,8 @@ module TimeTree
     # @raise [TimeTree::ApiError] if the nhttp 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, res if res.status != 201
 
@@ -214,10 +226,10 @@ module TimeTree
 
     def inspect
       limit_info = nil
-      if @ratelimit_limit
+      if defined?(@ratelimit_limit) && @ratelimit_limit
         limit_info = " ratelimit:#{@ratelimit_remaining}/#{@ratelimit_limit}"
       end
-      if @ratelimit_reset_at
+      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}>"
@@ -239,12 +251,28 @@ module TimeTree
 
     private
 
-    def to_model(data, included: nil)
-      TimeTree::BaseModel.to_model data, client: self, included: included
+    def check_token
+      check_required_property(@token, 'token')
+    end
+
+    def check_calendar_id(value)
+      check_required_property(value, 'calendar_id')
+    end
+
+    def check_event_id(value)
+      check_required_property(value, 'event_id')
     end
 
-    def ready_token?
-      @token.is_a?(String) && !@token.empty?
+    def check_required_property(value, name)
+      err = Error.new "#{name} is required."
+      raise err if value.nil?
+      raise err if value.to_s.empty?
+
+      true
+    end
+
+    def to_model(data, included: nil)
+      TimeTree::BaseModel.to_model data, client: self, included: included
     end
 
     def relationships_params(relationships, default)

data/lib/timetree/event.rb

@@ -38,9 +38,9 @@ module TimeTree
     # @return [TimeTree::User]
     attr_reader :creator
     # @return [TimeTree::Label]
-    attr_reader :label
+    attr_accessor :label
     # @return [Array<TimeTree::User>]
-    attr_reader :attendees
+    attr_accessor :attendees
 
     TIME_FIELDS = %i[start_at end_at updated_at created_at].freeze
     RELATIONSHIPS = %i[creator label attendees].freeze
@@ -53,28 +53,10 @@ module TimeTree
     # @raise [TimeTree::ApiError] if the http response status will not success.
     # @since 0.0.1
     def create
-      raise Error, 'client is required.' if @client.nil?
-
+      check_client
       @client.create_event calendar_id, data_params
     end
 
-    #
-    # Creates comment to the event.
-    #
-    # @return [TimeTree::Activity]
-    # @raise [TimeTree::Error] if @client is not set.
-    # @raise [TimeTree::ApiError] if the http response status will not success.
-    # @since 0.0.1
-    def create_comment(message)
-      raise Error, '@client is nil.' if @client.nil?
-
-      params = { type: 'activity', attributes: { calendar_id: calendar_id, event_id: id, content: message } }
-      activity = to_model params
-      return if activity.nil?
-
-      activity.create
-    end
-
     #
     # Updates the event.
     #
@@ -84,9 +66,7 @@ module TimeTree
     # @raise [TimeTree::ApiError] if the http response status will not success.
     # @since 0.0.1
     def update
-      raise Error, '@client is nil.' if @client.nil?
-      raise Error, 'id is required.' if id.nil?
-
+      check_client
       @client.update_event calendar_id, id, data_params
     end
 
@@ -99,12 +79,26 @@ module TimeTree
     # @raise [TimeTree::ApiError] if the http response status will not success.
     # @since 0.0.1
     def delete
-      raise Error, '@client is nil.' if @client.nil?
-      raise Error, 'id is required.' if id.nil?
-
+      check_client
       @client.delete_event calendar_id, id
     end
 
+    #
+    # Creates comment to the event.
+    #
+    # @return [TimeTree::Activity]
+    # @raise [TimeTree::Error] if @client is not set.
+    # @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
+
     #
     # convert to a TimeTree request body format.
     #

data/lib/timetree/version.rb

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

data/timetree.gemspec

@@ -37,4 +37,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest-reporters', '~> 1.4.2'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'webmock', '~> 3.7.6'
+  spec.add_development_dependency 'simplecov', '~> 0.18.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timetree
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.7.6
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
 description: Client for accessing TimeTree APIs
 email:
 - koshikawa2009@gmail.com
@@ -160,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.2
+  documentation_uri: https://www.rubydoc.info/gems/timetree/0.1.3
 post_install_message: 
 rdoc_options: []
 require_paths: