timetree 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd2a9142e5ee6614ec6e97f691d61a2b054d0db7616487efa84f7ecfa89aab82
-  data.tar.gz: f41663400a01d61da7e4cb26ef302c415ff238f8bc58c1b54b1d10156934ab6d
+  metadata.gz: '08f576804646a18cf1c980d7649f3cf621f7e98871d291bec881ba8232e69e6a'
+  data.tar.gz: 3740f58f68f0f6514b59295a7c3e8f57321fc10b4b5ca3fd6515da7b67a48c50
 SHA512:
-  metadata.gz: a7793feb335fcee92f1c19733206a67b3f2e94fcef7e809701db8fd31e80835689f4dbb604422223fcd9c2c6848a5a8ea8ece93dc401cfe65a2b99234c1dde65
-  data.tar.gz: ce9319e7839ce5663e2b15723b5492825332bab5265e7d57ba3d9bd84c59dd3a2b999ffb5de1c77c941e215c226a43699c4b5267aab790539c19e3ce11eb4a8d
+  metadata.gz: 5cd3358940be41c9e441ab348249b65628cb489df329687df949ff3f4a48a2749642f31f0cde56170d895acf35f63bd90c30c00d3491efb74ec8323eb501bd29
+  data.tar.gz: 8888d348d25e8c67645a50084443c79cba8a6d14c7aa7fbb43ae743abd2be8092b3a5ea5815edd35c115268c60bac1933438177c31f0e5ae0b27821e3b3d02b3

data/{.rubocom.yml → .rubocop.yml}

@@ -1,4 +1,5 @@
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.6
 
 Layout/AccessModifierIndentation:
@@ -23,12 +24,11 @@ Metrics/BlockNesting:
   Max: 2
 
 Layout/LineLength:
- AllowURI: true
- Enabled: false
+  Max: 120
 
 Metrics/MethodLength:
   CountComments: false
-  Max: 15
+  Max: 20
 
 Metrics/ParameterLists:
   Max: 4
@@ -39,10 +39,10 @@ Metrics/AbcSize:
 
 Style/CollectionMethods:
   PreferredMethods:
-    map:      'collect'
-    reduce:   'inject'
-    find:     'detect'
-    find_all: 'select'
+    map: "collect"
+    reduce: "inject"
+    find: "detect"
+    find_all: "select"
 
 Style/Documentation:
   Enabled: false
@@ -60,10 +60,13 @@ Style/ExpandPathArguments:
   Enabled: false
 
 Style/HashSyntax:
-  EnforcedStyle: hash_rockets
+  EnforcedStyle: ruby19
 
 Style/Lambda:
   Enabled: false
 
 Style/RaiseArgs:
-  EnforcedStyle: compact
+  EnforcedStyle: compact
+
+Style/AsciiComments:
+  Enabled: false

data/CHANGELOG.md

@@ -1,44 +1,70 @@
-# 0.2.0
+# CHANGELOG
+
+## 1.0.0
+
+- add Calendar App Client. (refs #28)
+- rename `TimeTree::OAuthApp::Client` from `TimeTree::Client`.
+
+## 0.3.2
+
+- remove zeitwerk dependency. (refs #29)
+
+## 0.3.1
+
+- fix rubocop warnings.
+
+## 0.3.0
+
+- refs #25 fix dependencies.
+- remove minitest-reporter.
+
+## 0.2.1
+
+- do refactor
+  - use `respond_to?(setter)` instead of `instance_methods.include?(setter)`.
+  - use getter method instead of instant variables if defined it.
+
+## 0.2.0
 
 - organize model classes.
 
-# 0.1.7
+## 0.1.7
 
 - refs #16 correct a mistake codecov badge url on README
 
-# 0.1.6
+## 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
+## 0.1.5
 
 - refs #6 setup GitHub Actions.
 
-# 0.1.4
+## 0.1.4
 
 - updates comments.
 
-# 0.1.3
+## 0.1.3
 
 - refs #7 #9 make the code coverage 100%.
 
-# 0.1.2
+## 0.1.2
 
 - refs #1 fix typo Event#recurrences to recurrence
 - refs #2 add a note for debugging guide on README
 
-# 0.1.1
+## 0.1.1
 
 - set current version on this gem's documentation_uri.
 - fixed typo on README.
 
-# 0.1.0
+## 0.1.0
 
 - did refactor and wrote comments.
 - started to use zeitwerk.
 - wrote README.
 
-# 0.0.1
+## 0.0.1
 
 - Initial release

data/README.md

@@ -1,4 +1,4 @@
-# Simple TimeTree APIs client
+# 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)
@@ -25,60 +25,85 @@ Or install it yourself as:
 
     $ gem install timetree
 
-## Usage
+## Usage for Calendar App
 
-The APIs client needs access token.
-Set a `token` variable to the value you got by above:
+The APIs client for Calendar App needs installation_id, application_id and private key.
 
 ```ruby
 # set token by TimeTree.configure methods.
 TimeTree.configure do |config|
-  config.token = '<YOUR_ACCESS_TOKEN>'
+  config.calendar_app_application_id = '<YOUR_APPLICATION_ID>'
+  config.calendar_app_private_key = File.read('<YOUR_PATH_TO_PEM>')
 end
-client = TimeTree::Client.new
+client = TimeTree::CalendarApp::Client.new('<INSTALLATION_ID>')
 
-# set token by TimeTree::Client initializer.
-client = TimeTree::Client.new('<YOUR_ACCESS_TOKEN>')
+# set token by TimeTree::CalendarApp::Client initializer.
+client = TimeTree::CalendarApp::Client.new('<INSTALLATION_ID>', '<YOUR_APPLICATION_ID>', '<YOUR_PRIVATE_KEY_CONTENT>')
+
+# get connected calendar's information.
+cal = client.calendar
+# => #<TimeTree::Calendar id:xxx_cal001>
+
+# get upcoming events on the calendar.
+evs = cal.upcoming_events
+# => [#<TimeTree::Event id:xxx_ev001>, #<TimeTree::Event id:xxx_ev002>, ...]
+ev = evs.first.title
+# => "Event Title"
+```
+
+## Usage for OAuth App
+
+The APIs client for OAuth App needs access token.
+
+```ruby
+# set token by TimeTree.configure methods.
+TimeTree.configure do |config|
+  config.oauth_app_token = '<YOUR_ACCESS_TOKEN>'
+end
+client = TimeTree::OAuthApp::Client.new
+
+# set token by TimeTree::OAuthApp::Client initializer.
+client = TimeTree::OAuthApp::Client.new('<YOUR_ACCESS_TOKEN>')
 
 # get a current user's information.
 user = client.current_user
-=> #<TimeTree::User id:xxx_u001>
+# => #<TimeTree::User id:xxx_u001>
 user.name
-=> "USER Name"
+# => "USER Name"
 
 # get current user's calendars.
 cals = client.calendars
-=> [#<TimeTree::Calendar id:xxx_cal001>, #<TimeTree::Calendar id:xxx_cal002>, ...]
+# => [#<TimeTree::Calendar id:xxx_cal001>, #<TimeTree::Calendar id:xxx_cal002>, ...]
 cal = cals.first
 cal.name
-=> "Calendar Name"
+# => "Calendar Name"
 
 # get upcoming events on the calendar.
 evs = cal.upcoming_events
-=> [#<TimeTree::Event id:xxx_ev001>, #<TimeTree::Event id:xxx_ev002>, ...]
+# => [#<TimeTree::Event id:xxx_ev001>, #<TimeTree::Event id:xxx_ev002>, ...]
 ev = evs.first
 ev.title
-=> "Event Title"
+# => "Event Title"
 
 # updates an event.
 ev.title += ' Updated'
 ev.start_at = Time.parse('2020-06-20 09:00 +09:00')
 ev.end_at = Time.parse('2020-06-20 10:00 +09:00')
 ev.update
-=> #<TimeTree::Event id:xxx_ev001>
+# => #<TimeTree::Event id:xxx_ev001>
 
 # creates an event.
 copy_ev = ev.dup
 new_ev = copy_ev.create
-=> #<TimeTree::Event id:xxx_new_ev001>
+# => #<TimeTree::Event id:xxx_new_ev001>
 
 # deletes an event.
 ev.delete
-=> true
+# => true
 
 # creates a comment to an event.
 ev.create_comment 'Hi there!'
-=> #<TimeTree::Activity id:xxx_act001>
+# => #<TimeTree::Activity id:xxx_act001>
 
 # handles APIs error.
 begin
@@ -90,7 +115,11 @@ rescue TimeTree::ApiError => e
   e.response
   => #<Faraday::Response>
 end
+```
+
+## Logging
 
+```ruby
 # if the log level set :debug, you can get the request/response information.
 TimeTree.configuration.logger.level = :debug
 => #<TimeTree::Event id:event_id_001_not_found>
@@ -99,6 +128,8 @@ I, [2020-06-24T10:05:07.294807]  INFO -- : GET https://timetreeapis.com/calendar
 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"}
 ```
 
+More in-depth method documentation can be found at [RubyDoc.info](https://www.rubydoc.info/gems/timetree/).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on [GitHub](https://github.com/koshilife/timetree-api-ruby-client). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/lib/timetree.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
-require 'zeitwerk'
-loader = Zeitwerk::Loader.for_gem
-loader.inflector.inflect(
-  'timetree' => 'TimeTree'
-)
-loader.collapse('**/models')
-loader.setup
+Dir[
+  File.join(
+    File.dirname(__FILE__),
+    'timetree',
+    '**',
+    '*'
+  )
+].sort.each do |f|
+  next if File.directory? f
+
+  require f
+end
 
 # module for TimeTree apis client
 module TimeTree

data/lib/timetree/api_error.rb

@@ -23,7 +23,7 @@ module TimeTree
     end
 
     def inspect
-      "\#<#{self.class}:#{object_id} title:#{@title}, status:#{@status}>"
+      "\#<#{self.class}:#{object_id} title:#{title}, status:#{status}>"
     end
   end
 end

data/lib/timetree/base_client.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module TimeTree
+  class BaseClient
+    API_HOST = 'https://timetreeapis.com'
+    # @return [Integer]
+    attr_reader :ratelimit_limit
+    # @return [Integer]
+    attr_reader :ratelimit_remaining
+    # @return [Time]
+    attr_reader :ratelimit_reset_at
+
+    #
+    # update ratelimit properties
+    #
+    # @param res [Faraday::Response]
+    # apis http response.
+    def update_ratelimit(res)
+      limit = res.headers['x-ratelimit-limit']
+      remaining = res.headers['x-ratelimit-remaining']
+      reset = res.headers['x-ratelimit-reset']
+      @ratelimit_limit = limit.to_i if limit
+      @ratelimit_remaining = remaining.to_i if remaining
+      @ratelimit_reset_at = Time.at reset.to_i if reset
+    end
+
+  private
+
+    def check_event_id(value)
+      check_required_property(value, 'event_id')
+    end
+
+    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)
+      params = {}
+      relationships ||= default
+      params[:include] = relationships.join ',' if relationships.is_a? Array
+      params
+    end
+  end
+end

data/lib/timetree/calendar_app/access_token.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TimeTree
+  module CalendarApp
+    class AccessToken
+      # @return [String]
+      attr_reader :token
+      # @return [Integer]
+      attr_reader :expire_at
+
+      def initialize(token, expire_at)
+        @token = token
+        @expire_at = expire_at
+      end
+
+      #
+      # Returns the access token is expired or not.
+      #
+      # @return [Boolean]
+      def expired?
+        Time.now.to_i > expire_at
+      end
+    end
+  end
+end

data/lib/timetree/calendar_app/client.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'jwt'
+
+module TimeTree
+  module CalendarApp
+    # TimeTree API CalendarApp client.
+    class Client < BaseClient
+      # @return [Integer]
+      attr_reader :installation_id
+      # @return [String]
+      attr_reader :application_id
+      # @return [String]
+      attr_reader :private_key
+      # @return [String]
+      attr_reader :token
+
+      # @param installation_id [Integer] CalendarApp's installation id
+      # @param application_id [String] CalendarApp id
+      # @param private_key [String] RSA private key for CalendarApp
+      def initialize(installation_id, application_id = nil, private_key = nil)
+        @installation_id = installation_id
+        @application_id = application_id || TimeTree.configuration.calendar_app_application_id
+        @private_key = OpenSSL::PKey::RSA.new((private_key || TimeTree.configuration.calendar_app_private_key).to_s)
+        check_client_requirement
+        @http_cmd = HttpCommand.new(API_HOST, self)
+      rescue OpenSSL::PKey::RSAError
+        raise Error.new 'private_key must be RSA private key.'
+      end
+
+      #
+      # Get a calendar information related to CalendarApp
+      #
+      # @param include_relationships [Array<symbol>]
+      # includes association's object in the response.
+      # @return [TimeTree::Calendar]
+      # @raise [TimeTree::ApiError] if the http response status will not success.
+      # @since 1.0.0
+      def calendar(include_relationships: nil)
+        check_access_token
+        params = relationships_params(include_relationships, Calendar::RELATIONSHIPS)
+        res = http_cmd.get('/calendar', params)
+        raise ApiError.new(res) if res.status != 200
+
+        to_model(res.body[:data], included: res.body[:included])
+      end
+
+      #
+      # Get a calendar's member information.
+      #
+      # @return [Array<TimeTree::User>]
+      # @raise [TimeTree::ApiError] if the http response status will not success.
+      # @since 1.0.0
+      def calendar_members
+        check_access_token
+        res = http_cmd.get('/calendar/members')
+        raise ApiError.new(res) if res.status != 200
+
+        res.body[:data].map { |item| to_model(item) }
+      end
+
+      #
+      # Get an event's information.
+      #
+      # @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 event_id arg is empty.
+      # @raise [TimeTree::ApiError] if the http response status will not success.
+      # @since 1.0.0
+      def event(event_id, include_relationships: nil)
+        check_event_id event_id
+        check_access_token
+        params = relationships_params(include_relationships, Event::RELATIONSHIPS)
+        res = http_cmd.get("/calendar/events/#{event_id}", params)
+        raise ApiError.new(res) if res.status != 200
+
+        to_model(res.body[:data], included: res.body[:included])
+      end
+
+      #
+      # Get events' information after a request date.
+      #
+      # @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::ApiError] if the http response status will not success.
+      # @since 1.0.0
+      def upcoming_events(days: 7, timezone: 'UTC', include_relationships: nil)
+        check_access_token
+        params = relationships_params(include_relationships, Event::RELATIONSHIPS)
+        params.merge!(days: days, timezone: timezone)
+        res = http_cmd.get('/calendar/upcoming_events', params)
+        raise ApiError.new(res) if res.status != 200
+
+        included = res.body[:included]
+        res.body[:data].map { |item| to_model(item, included: included) }
+      end
+
+      #
+      # Creates an event.
+      #
+      # @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 1.0.0
+      def create_event(params)
+        check_access_token
+        res = http_cmd.post('/calendar/events', params)
+        raise ApiError.new(res) if res.status != 201
+
+        to_model(res.body[:data])
+      end
+
+      #
+      # Updates an event.
+      #
+      # @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 event_id arg is empty.
+      # @raise [TimeTree::ApiError] if the http response status will not success.
+      # @since 1.0.0
+      def update_event(event_id, params)
+        check_event_id event_id
+        check_access_token
+        res = http_cmd.put("/calendar/events/#{event_id}", params)
+        raise ApiError.new(res) if res.status != 200
+
+        to_model(res.body[:data])
+      end
+
+      #
+      # Deletes an event.
+      #
+      # @param event_id [String] event's id.
+      # @return [true] if the operation succeeded.
+      # @raise [TimeTree::Error] if the event_id arg is empty.
+      # @raise [TimeTree::ApiError] if the http response status will not success.
+      # @since 1.0.0
+      def delete_event(event_id)
+        check_event_id event_id
+        check_access_token
+        res = http_cmd.delete("/calendar/events/#{event_id}")
+        raise ApiError.new(res) if res.status != 204
+
+        true
+      end
+
+      #
+      # Creates a comment.
+      #
+      # @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 event_id arg is empty.
+      # @raise [TimeTree::ApiError] if the http response status is not success.
+      # @since 1.0.0
+      def create_activity(event_id, params)
+        check_event_id event_id
+        check_access_token
+        res = http_cmd.post("/calendar/events/#{event_id}/activities", params)
+        raise ApiError.new(res) if res.status != 201
+
+        activity = to_model(res.body[:data])
+        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
+
+      attr_reader :http_cmd, :access_token
+
+      def check_client_requirement
+        check_required_property(installation_id, 'installation_id')
+        check_required_property(application_id, 'application_id')
+      end
+
+      def check_access_token
+        return if access_token?
+
+        get_access_token
+      end
+
+      def access_token?
+        access_token && !access_token.expired?
+      end
+
+      def get_access_token
+        res = http_cmd.post("/installations/#{installation_id}/access_tokens") do |req|
+          req.headers['Authorization'] = "Bearer #{jwt}"
+        end
+        raise ApiError.new(res) if res.status != 200
+
+        @access_token = AccessToken.new(res.body[:access_token], res.body[:expire_at])
+        @token = access_token.token
+      end
+
+      def jwt
+        now = Time.now.to_i
+        payload = {
+          iat: now,
+          exp: now + (10 * 60), # JWT expires in 10 minutes
+          iss: application_id
+        }
+        JWT.encode(payload, private_key, 'RS256')
+      end
+    end
+  end
+end