timetree 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a43c7c885e6f0f2e55fdcf9b6c145e13e981fea4fee23dc468f5f16923826c0
-  data.tar.gz: b1dffa32b6a9d80ebca9e6de06a030e43e9d2bfe895bf9ac5ad4fa687d8f3b4a
+  metadata.gz: dd2a9142e5ee6614ec6e97f691d61a2b054d0db7616487efa84f7ecfa89aab82
+  data.tar.gz: f41663400a01d61da7e4cb26ef302c415ff238f8bc58c1b54b1d10156934ab6d
 SHA512:
-  metadata.gz: be24215ef1f52ccb2b0c8a8ce87f29dc2132e5987ba99533c73017cbc6a669d45dd5d565c1ff3fa1824d66cadeeddaf91f36ccaf6abd1150c755e0f836383e18
-  data.tar.gz: 1eb41d1864cabaf26293102c7a1b288da4e36930bce4599270e9e57e3b00e85a03e1d0bf2296f1d52ba0d26fcc4418ce287fc45a382da63c99c66209840890c3
+  metadata.gz: a7793feb335fcee92f1c19733206a67b3f2e94fcef7e809701db8fd31e80835689f4dbb604422223fcd9c2c6848a5a8ea8ece93dc401cfe65a2b99234c1dde65
+  data.tar.gz: ce9319e7839ce5663e2b15723b5492825332bab5265e7d57ba3d9bd84c59dd3a2b999ffb5de1c77c941e215c226a43699c4b5267aab790539c19e3ce11eb4a8d

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

@@ -0,0 +1,37 @@
+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
+        continue-on-error: true
+        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,5 +7,4 @@
 /spec/reports/
 /tmp/
 
-coverage
-Gemfile.lock
+Gemfile.lock

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# 0.2.0
+
+- organize model classes.
+
+# 0.1.7
+
+- refs #16 correct a mistake codecov badge url on README
+
+# 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%.

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
 

data/bin/console

@@ -1,14 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "timetree"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
+require 'bundler/setup'
+require 'timetree'
+require 'irb'
 IRB.start(__FILE__)

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/lib/timetree.rb

@@ -5,6 +5,7 @@ loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect(
   'timetree' => 'TimeTree'
 )
+loader.collapse('**/models')
 loader.setup
 
 # module for TimeTree apis client

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/{base_model.rb → models/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 → models/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/{event.rb → models/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.2.0'
 end

data/timetree.gemspec

@@ -33,9 +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 'webmock', '~> 3.7.6'
   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.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-08-08 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
@@ -109,33 +123,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: 0.18.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: 0.18.5
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: 3.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: 3.7.6
 description: Client for accessing TimeTree APIs
 email:
 - koshikawa2009@gmail.com
@@ -143,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
@@ -155,16 +170,16 @@ files:
 - bin/console
 - bin/setup
 - lib/timetree.rb
-- lib/timetree/activity.rb
 - lib/timetree/api_error.rb
-- lib/timetree/base_model.rb
-- lib/timetree/calendar.rb
 - lib/timetree/client.rb
 - lib/timetree/configuration.rb
-- lib/timetree/event.rb
 - lib/timetree/http_command.rb
-- lib/timetree/label.rb
-- lib/timetree/user.rb
+- lib/timetree/models/activity.rb
+- lib/timetree/models/base_model.rb
+- lib/timetree/models/calendar.rb
+- lib/timetree/models/event.rb
+- lib/timetree/models/label.rb
+- lib/timetree/models/user.rb
 - lib/timetree/version.rb
 - timetree.gemspec
 homepage: https://github.com/koshilife/timetree-api-ruby-client
@@ -174,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.3
+  documentation_uri: https://www.rubydoc.info/gems/timetree/0.2.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -190,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