timetree 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de434a07fd2b0d7024c41f1bc6a555a053fe07da002a60b91479a3f239a5bac6
-  data.tar.gz: a6ab608d7d5bceb77e05d97b2243bc804171602d538f29494b3c6796737f7fc1
+  metadata.gz: bffe4b8c7f5f0b823a2e9ea69366805c162b47c97a0ad38a3f244ac0d9d11362
+  data.tar.gz: a9b07113a787279349db5840bbe10f48c1e9fef4523a3be6a79e7334b81f54d5
 SHA512:
-  metadata.gz: 67ba773c6beef87fb6e23c9e386b6d685ac4317b99516690ca321f3c216df695fa9a5b7a33c979dd142e37cd95d9ab0f400ffb3c421f77ac20339b2ed344495c
-  data.tar.gz: 85957d72ca8df7f9be67cfaa7b962d892add2a3d2c5745efd41d89a0120553628e36c828de5b6b482e57e0cce7a67ce9959df2542222e4217f339a495283997c
+  metadata.gz: 51114aab5225929e87d24881ff392c65ea45271c80c93f70d46667d51a459c7776976e941b11a5759da1946f6d00d4169c1fc09c87aae4fd810fca60aaae54b7
+  data.tar.gz: 5e82739d7134e02c937cb321e6d783784129188177a565be6f5f7f294d6df509e9444df21f1a2521456f9f0899e56102f9f22534ff3bde35a0e4a04fcf94504e

data/.github/workflows/gem-push.yml

@@ -0,0 +1,36 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Build and test
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake test
+        env:
+          CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on: pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Build and test
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake test
+        env:
+          CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}

data/.gitignore

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

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# 0.1.6
+
+- refs #16 add code coverage to readme.
+- refs #17 update deprecated `version` for `ruby-version` on gem-push.yml.
+
+# 0.1.5
+
+- refs #6 setup GitHub Actions.
+
+# 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

data/README.md

@@ -1,6 +1,9 @@
 # Simple TimeTree APIs client
 
+[![Test](https://github.com/koshilife/timetree-api-ruby-client/workflows/Test/badge.svg)](https://github.com/koshilife/timetree-api-ruby-client/actions?query=workflow%3ATest)
+[![codecov](https://codecov.io/gh/koshilife/timetree-api-ruby-client/branch/master/graph/badge.svg)](https://codecov.io/gh/koshilife/timetree-api-ruby-client)
 [![Gem Version](https://badge.fury.io/rb/timetree.svg)](http://badge.fury.io/rb/timetree)
+[![license](https://img.shields.io/github/license/koshilife/timetree-api-ruby-client)](https://github.com/koshilife/timetree-api-ruby-client/blob/master/LICENSE.txt)
 
 ## About
 
@@ -94,8 +97,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

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

@@ -25,12 +25,11 @@ 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)
-      raise Error, '@client is nil.' if @client.nil?
-
+      check_client
       @client.event id, event_id
     end
 
@@ -42,41 +41,40 @@ 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')
-      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>]
-    # @raise [TimeTree::Error] if @client is not set.
+    # @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 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>]
-    # @raise [TimeTree::Error] if @client is not set.
+    # @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 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
 
@@ -41,9 +40,11 @@ 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)
+      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
@@ -73,9 +74,11 @@ 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)
+      check_calendar_id cal_id
       res = @http_cmd.get "/calendars/#{cal_id}/labels"
       raise ApiError, res if res.status != 200
 
@@ -87,9 +90,11 @@ 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)
+      check_calendar_id cal_id
       res = @http_cmd.get "/calendars/#{cal_id}/members"
       raise ApiError, res if res.status != 200
 
@@ -104,9 +109,13 @@ 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)
+      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
@@ -125,9 +134,11 @@ 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)
+      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
@@ -147,9 +158,11 @@ 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)
+      check_calendar_id cal_id
       res = @http_cmd.post "/calendars/#{cal_id}/events", params
       raise ApiError, res if res.status != 201
 
@@ -166,9 +179,13 @@ 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)
+      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
 
@@ -183,9 +200,13 @@ 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)
+      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
 
@@ -200,9 +221,13 @@ 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
+      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 +239,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 +264,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
@@ -49,44 +49,23 @@ 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
-      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.
     #
     # @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
-      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
 
@@ -94,17 +73,28 @@ 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
-      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, @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
+      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.7'
 end

data/timetree.gemspec

@@ -33,8 +33,10 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'zeitwerk', '~> 2.3.0'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'codecov', '~> 0.1.17'
   spec.add_development_dependency 'minitest', '~> 5.14.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.4.2'
   spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'simplecov', '~> 0.18.5'
   spec.add_development_dependency 'webmock', '~> 3.7.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timetree
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.17
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.17
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+- !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
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -129,9 +157,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocom.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -160,7 +189,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.7
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -176,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Client for accessing TimeTree APIs

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.3
-before_install: gem install bundler -v 2.1.4