timetree 0.2.0 → 1.0.0

data/lib/timetree/models/label.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'timetree/models/base_model'
+
 module TimeTree
   # Model for TimeTree color theme.
   class Label < BaseModel

data/lib/timetree/models/user.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'timetree/models/base_model'
+
 module TimeTree
   # Model for TimeTree user.
   class User < BaseModel

data/lib/timetree/oauth_app/client.rb

@@ -0,0 +1,256 @@
+# frozen_string_literal: true
+
+module TimeTree
+  module OAuthApp
+    # TimeTree API OAuthApp client.
+    class Client < BaseClient
+      # @return [String]
+      attr_reader :token
+
+      # @param token [String] a TimeTree's access token.
+      def initialize(token = nil)
+        @token = token || TimeTree.configuration.oauth_app_token
+        check_token
+        @http_cmd = HttpCommand.new(API_HOST, self)
+      end
+
+      #
+      # Get current user information.
+      #
+      # @return [TimeTree::User]
+      # @raise [TimeTree::ApiError] if the http response status will not success.
+      # @since 0.0.1
+      def current_user
+        res = @http_cmd.get '/user'
+        raise ApiError.new(res) if res.status != 200
+
+        to_model res.body[:data]
+      end
+
+      #
+      # Get a single calendar's information.
+      #
+      # @param cal_id [String] calendar's id.
+      # @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.new(res) if res.status != 200
+
+        to_model(res.body[:data], included: res.body[:included])
+      end
+
+      #
+      # Get calendar list that current user can access.
+      #
+      # @param include_relationships [Array<symbol>]
+      # includes association's object in the response.
+      # @return [Array<TimeTree::Calendar>]
+      # @raise [TimeTree::ApiError] if the http response status will not success.
+      # @since 0.0.1
+      def calendars(include_relationships: nil)
+        params = relationships_params(include_relationships, Calendar::RELATIONSHIPS)
+        res = @http_cmd.get '/calendars', params
+        raise ApiError.new(res) if res.status != 200
+
+        included = res.body[:included]
+        res.body[:data].map { |item| to_model(item, included: included) }
+      end
+
+      #
+      # Get a calendar's label information used in event.
+      #
+      # @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.new(res) if res.status != 200
+
+        res.body[:data].map { |item| to_model(item) }
+      end
+
+      #
+      # Get a calendar's member information.
+      #
+      # @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.new(res) if res.status != 200
+
+        res.body[:data].map { |item| to_model item }
+      end
+
+      #
+      # Get the event's information.
+      #
+      # @param cal_id [String] calendar's id.
+      # @param event_id [String] event's id.
+      # @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.new(res) if res.status != 200
+
+        ev = to_model(res.body[:data], included: res.body[:included])
+        ev.calendar_id = cal_id
+        ev
+      end
+
+      #
+      # Get the events' information after a request date.
+      #
+      # @param cal_id[String] calendar's id.
+      # @param days [Integer] The number of days to get.
+      # @param timezone [String] Timezone.
+      # @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
+        raise ApiError.new(res) if res.status != 200
+
+        included = res.body[:included]
+        res.body[:data].map do |item|
+          ev = to_model(item, included: included)
+          ev.calendar_id = cal_id
+          ev
+        end
+      end
+
+      #
+      # Creates an event to the calendar.
+      #
+      # @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.new(res) if res.status != 201
+
+        ev = to_model res.body[:data]
+        ev.calendar_id = cal_id
+        ev
+      end
+
+      #
+      # Updates an event.
+      #
+      # @param cal_id [String] calendar's id.
+      # @param event_id [String] event's id.
+      # @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.new(res) if res.status != 200
+
+        ev = to_model res.body[:data]
+        ev.calendar_id = cal_id
+        ev
+      end
+
+      #
+      # Deletes an event.
+      #
+      # @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.new(res) if res.status != 204
+
+        true
+      end
+
+      #
+      # Creates comment to an event.
+      #
+      # @param cal_id [String] calendar's id.
+      # @param event_id [String] event's id.
+      # @param params [Hash]
+      # comment's information specified in TimeTree request body format.
+      # @return [TimeTree::Activity]
+      # @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.new(res) if res.status != 201
+
+        activity = to_model res.body[:data]
+        activity.calendar_id = cal_id
+        activity.event_id = event_id
+        activity
+      end
+
+      def inspect
+        limit_info = nil
+        if defined?(@ratelimit_limit) && @ratelimit_limit
+          limit_info = " ratelimit:#{ratelimit_remaining}/#{ratelimit_limit}"
+        end
+        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}>"
+      end
+
+    private
+
+      def check_token
+        check_required_property(@token, 'token')
+      end
+
+      def check_calendar_id(value)
+        check_required_property(value, 'calendar_id')
+      end
+    end
+  end
+end

data/lib/timetree/version.rb

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

data/timetree.gemspec

@@ -28,15 +28,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'faraday', '~> 1.0.1'
-  spec.add_runtime_dependency 'faraday_middleware', '~> 1.0.0'
-  spec.add_runtime_dependency 'zeitwerk', '~> 2.3.0'
+  spec.add_runtime_dependency 'faraday', '>= 1.0.1'
+  spec.add_runtime_dependency 'faraday_middleware', '>= 1.0.0'
+  spec.add_runtime_dependency 'jwt', '>= 2.2.2'
 
-  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'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,155 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: timetree
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-08 00:00:00.000000000 Z
+date: 2020-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: zeitwerk
+  name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.17
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.17
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.14.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.14.0
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: '0'
 description: Client for accessing TimeTree APIs
 email:
 - koshikawa2009@gmail.com
@@ -160,7 +146,7 @@ files:
 - ".github/workflows/gem-push.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
-- ".rubocom.yml"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -171,15 +157,19 @@ files:
 - bin/setup
 - lib/timetree.rb
 - lib/timetree/api_error.rb
-- lib/timetree/client.rb
+- lib/timetree/base_client.rb
+- lib/timetree/calendar_app/access_token.rb
+- lib/timetree/calendar_app/client.rb
 - lib/timetree/configuration.rb
 - lib/timetree/http_command.rb
 - lib/timetree/models/activity.rb
+- lib/timetree/models/application.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/oauth_app/client.rb
 - lib/timetree/version.rb
 - timetree.gemspec
 homepage: https://github.com/koshilife/timetree-api-ruby-client
@@ -189,7 +179,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.2.0
+  documentation_uri: https://www.rubydoc.info/gems/timetree/1.0.0
 post_install_message: 
 rdoc_options: []
 require_paths: