timetree 0.0.1 → 0.1.0

data/lib/timetree/configuration.rb

@@ -3,9 +3,13 @@
 require 'logger'
 
 module TimeTree
+  # TimeTree apis client configuration.
   class Configuration
-    attr_accessor :access_token
+    # @return [String]
+    attr_accessor :token
+    # @return [Logger]
     attr_accessor :logger
+
     def initialize
       logger = Logger.new(STDOUT)
       logger.level = :warn

data/lib/timetree/event.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module TimeTree
+  # Model for TimeTree event or keep.
+  class Event < BaseModel
+    # @return [Striing]
+    attr_accessor :category
+    # @return [Striing]
+    attr_accessor :title
+    # @return [Boolean]
+    attr_accessor :all_day
+    # @return [Time]
+    attr_accessor :start_at
+    # @return [Striing]
+    attr_accessor :start_timezone
+    # @return [Time]
+    attr_accessor :end_at
+    # @return [String]
+    attr_accessor :end_timezone
+    # @return [String]
+    attr_accessor :recurrences
+    # @return [String]
+    attr_accessor :recurring_uuid
+    # @return [String]
+    attr_accessor :description
+    # @return [String]
+    attr_accessor :location
+    # @return [String]
+    attr_accessor :url
+    # @return [Time]
+    attr_accessor :updated_at
+    # @return [Time]
+    attr_accessor :created_at
+    # calendar's id.
+    # @return [String]
+    attr_accessor :calendar_id
+
+    # @return [TimeTree::User]
+    attr_reader :creator
+    # @return [TimeTree::Label]
+    attr_reader :label
+    # @return [Array<TimeTree::User>]
+    attr_reader :attendees
+
+    TIME_FIELDS = %i[start_at end_at updated_at created_at].freeze
+    RELATIONSHIPS = %i[creator label attendees].freeze
+
+    #
+    # Creates an event to the associated calendar.
+    #
+    # @return [TimeTree::Event]
+    # @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
+      raise Error, 'client is required.' if @client.nil?
+
+      @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::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?
+
+      @client.update_event calendar_id, id, data_params
+    end
+
+    #
+    # 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::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?
+
+      @client.delete_event calendar_id, id
+    end
+
+    #
+    # convert to a TimeTree request body format.
+    #
+    # @return [Hash]
+    # @since 0.0.1
+    def data_params
+      {
+        data: {
+          attributes: {
+            category: category,
+            title: title,
+            all_day: all_day,
+            start_at: start_at.iso8601,
+            start_timezone: start_timezone,
+            end_at: end_at.iso8601,
+            end_timezone: end_timezone,
+            description: description,
+            location: location,
+            url: url
+          },
+          relationships: relationships_params
+        }
+      }
+    end
+
+    private
+
+    def relationships_params
+      current_label = label ? { type: 'label', id: label.id } : @relationships[:label]
+      current_attendees = attendees ? attendees.map { |u| { type: 'user', id: u.id } } : @relationships[:attendees]
+      {
+        label: { data: current_label },
+        attendees: { data: current_attendees }
+      }
+    end
+  end
+end

data/lib/timetree/http_command.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+module TimeTree
+  # Command for HTTP request.
+  class HttpCommand
+    def initialize(host, client)
+      @host = host
+      @client = client
+      @logger = TimeTree.configuration.logger
+    end
+
+    # @param path [String] String or URI to access.
+    # @param params [Hash] Hash of URI query unencoded key/value pairs.
+    def get(path, params = {})
+      logger.info "GET #{connection.build_url("#{@host}#{path}", params)}"
+      res = connection.get path, params
+      @client.update_ratelimit(res)
+      logger.debug "Response status:#{res.status}, body:#{res.body}"
+      res
+    end
+
+    # @param path [String] String or URI to access.
+    # @param body_params [Hash]
+    # The request bodythat will eventually be converted to JSON.
+    def post(path, body_params = {})
+      @logger.debug "POST #{@host}#{path} body:#{body_params}"
+      headers = { 'Content-Type' => 'application/json' }
+      res = connection.run_request :post, path, body_params.to_json, headers
+      @client.update_ratelimit(res)
+      logger.debug "Response status:#{res.status}, body:#{res.body}"
+      res
+    end
+
+    # @param path [String] String or URI to access.
+    # @param body_params [Hash]
+    # The request bodythat will eventually be converted to JSON.
+    def put(path, body_params = {})
+      logger.debug "PUT #{@host}#{path} body:#{body_params}"
+      headers = { 'Content-Type' => 'application/json' }
+      res = connection.run_request :put, path, body_params.to_json, headers
+      @client.update_ratelimit(res)
+      logger.debug "Response status:#{res.status}, body:#{res.body}"
+      res
+    end
+
+    # @param path [String] String or URI to access.
+    # @param params [Hash] Hash of URI query unencoded key/value pairs.
+    def delete(path, params = {})
+      @logger.debug "DELETE #{@host}#{path} params:#{params}"
+      res = connection.delete path, params
+      @client.update_ratelimit(res)
+      logger.debug "Response status:#{res.status}, body:#{res.body}"
+      res
+    end
+
+    private
+
+    attr_reader :logger
+
+    def connection
+      Faraday.new(
+        url: @host,
+        headers: base_request_headers
+      ) do |builder|
+        builder.response :json, parser_options: { symbolize_names: true }, content_type: /\bjson$/
+      end
+    end
+
+    def base_request_headers
+      {
+        'Accept' => 'application/vnd.timetree.v1+json',
+        'Authorization' => "Bearer #{@client.token}"
+      }
+    end
+  end
+end

data/lib/timetree/label.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TimeTree
+  # Model for TimeTree color theme.
+  class Label < BaseModel
+    # @return [String]
+    attr_accessor :name
+    # @return [String]
+    attr_accessor :color
+  end
+end

data/lib/timetree/user.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TimeTree
+  # Model for TimeTree user.
+  class User < BaseModel
+    # @return [String]
+    attr_accessor :name
+    # @return [String]
+    attr_accessor :description
+    # @return [String]
+    attr_accessor :image_url
+  end
+end

data/lib/timetree/version.rb

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

data/timetree.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
 
   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_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.14.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timetree
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-21 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -127,9 +141,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/models.rb
+- lib/timetree/event.rb
+- lib/timetree/http_command.rb
+- lib/timetree/label.rb
+- lib/timetree/user.rb
 - lib/timetree/version.rb
 - timetree.gemspec
 homepage: https://github.com/koshilife/timetree-api-ruby-client

data/lib/timetree/models.rb

@@ -1,282 +0,0 @@
-# frozen_string_literal: true
-
-require 'time'
-
-module TimeTree
-  class BaseModel
-    attr_reader :id
-    attr_reader :type
-    attr_accessor :relationships
-
-    # @param data [Hash]
-    # @param client [TimeTree::Client]
-    # @return [TimeTree::BaseModel]
-    def self.to_model(data, included: nil, client: nil)
-      id = data[:id]
-      type = data[:type]
-      return if type.nil?
-
-      attributes = data[:attributes] || {}
-      relationships = data[:relationships] || {}
-      params = {
-        id: id,
-        type: type,
-        client: client,
-        attributes: attributes,
-        relationships: relationships,
-        included: included
-      }
-
-      case type
-      when 'user'
-        User.new(**params)
-      when 'label'
-        Label.new(**params)
-      when 'event'
-        Event.new(**params)
-      when 'calendar'
-        Calendar.new(**params)
-      when 'activity'
-        Activity.new(**params)
-      end
-    end
-
-    def initialize(id:, type:, client: nil, attributes: nil, relationships: nil, included: nil)
-      @id = id
-      @type = type
-      @client = client
-      set_attributes attributes
-      set_relationships relationships, included
-    end
-
-    def inspect
-      "\#<#{self.class}:#{object_id} id:#{id}>"
-    end
-
-    private
-
-    def to_model(data)
-      self.class.to_model data, client: @client
-    end
-
-    def set_attributes(attributes)
-      return unless attributes.is_a? Hash
-      return if attributes.empty?
-
-      setter_methods = self.class.instance_methods.select { |method| method.to_s.end_with? '=' }
-      attributes.each do |key, value|
-        setter = "#{key.to_sym}=".to_sym
-        next unless setter_methods.include? setter
-
-        if defined?(self.class::TIME_FIELDS) && self.class::TIME_FIELDS.include?(key)
-          value = Time.parse value
-        end
-        instance_variable_set "@#{key}", value
-      end
-    end
-
-    def set_relationships(relationships, included)
-      return unless relationships.is_a? Hash
-      return if relationships.empty?
-      return unless defined? self.class::RELATIONSHIPS
-      return if self.class::RELATIONSHIPS.empty?
-
-      self.class::RELATIONSHIPS.each do |key|
-        relation = relationships[key]
-        next unless relation
-        next unless relation[:data]
-
-        @relationships ||= {}
-        @relationships[key] = relation[:data]
-      end
-
-      return if included.nil?
-      return unless included.is_a? Array
-      return if included.empty?
-
-      set_relationship_data_if_included(included)
-    end
-
-    def set_relationship_data_if_included(included)
-      @_relation_data_dic = {}
-      included.each do |data|
-        item = to_model(data)
-        next unless item
-
-        @_relation_data_dic[item.type] ||= {}
-        @_relation_data_dic[item.type][item.id] = item
-      end
-      detect_relation_data = lambda { |type, id|
-        return unless @_relation_data_dic[type]
-
-        @_relation_data_dic[type][id]
-      }
-      @relationships.each do |key, id_data|
-        relation_data = nil
-        if id_data.is_a? Array
-          relation_data = []
-          id_data.each do |d|
-            item = detect_relation_data.call(d[:type], d[:id])
-            relation_data << item if item
-          end
-        elsif id_data.is_a? Hash
-          relation_data = detect_relation_data.call(id_data[:type], id_data[:id])
-        end
-        instance_variable_set "@#{key}", relation_data if relation_data
-      end
-    end
-  end
-
-  class User < BaseModel
-    attr_accessor :name
-    attr_accessor :description
-    attr_accessor :image_url
-  end
-
-  class Label < BaseModel
-    attr_accessor :name
-    attr_accessor :color
-  end
-
-  class Calendar < BaseModel
-    attr_accessor :name
-    attr_accessor :description
-    attr_accessor :color
-    attr_accessor :order
-    attr_accessor :image_url
-    attr_accessor :created_at
-
-    TIME_FIELDS = %i[created_at].freeze
-    RELATIONSHIPS = %i[labels members].freeze
-
-    def event(event_id)
-      return if @client.nil?
-
-      @client.event id, event_id
-    end
-
-    def upcoming_events(days: 7, timezone: 'UTC')
-      return if @client.nil?
-
-      @client.upcoming_events id, days: days, timezone: timezone
-    end
-
-    def labels
-      return @labels if defined? @labels
-      return if @client.nil?
-
-      @labels = @client.calendar_labels id
-    end
-
-    def members
-      return @members if defined? @members
-      return if @client.nil?
-
-      @members = @client.calendar_members id
-    end
-  end
-
-  class Event < BaseModel
-    attr_accessor :category
-    attr_accessor :title
-    attr_accessor :all_day
-    attr_accessor :start_at
-    attr_accessor :start_timezone
-    attr_accessor :end_at
-    attr_accessor :end_timezone
-    attr_accessor :recurrences
-    attr_accessor :recurring_uuid
-    attr_accessor :description
-    attr_accessor :location
-    attr_accessor :url
-    attr_accessor :updated_at
-    attr_accessor :created_at
-    attr_accessor :calendar_id
-
-    attr_reader :creator
-    attr_reader :label
-    attr_reader :attendees
-
-    TIME_FIELDS = %i[start_at end_at updated_at created_at].freeze
-    RELATIONSHIPS = %i[creator label attendees].freeze
-
-    def create
-      return if @client.nil?
-
-      @client.create_event calendar_id, data_params
-    end
-
-    def create_comment(message)
-      return 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
-
-    def update
-      return if @client.nil?
-      return if id.nil?
-
-      @client.update_event calendar_id, id, data_params
-    end
-
-    def delete
-      return if @client.nil?
-      return if id.nil?
-
-      @client.delete_event calendar_id, id
-    end
-
-    def data_params
-      attributes_params = {
-        category: category,
-        title: title,
-        all_day: all_day,
-        start_at: start_at.iso8601,
-        start_timezone: start_timezone,
-        end_at: end_at.iso8601,
-        end_timezone: end_timezone,
-        description: description,
-        location: location,
-        url: url
-      }
-      relationhips_params = {}
-      if @relationships[:label]
-        label_data = { id: @relationships[:label], type: 'label' }
-        relationhips_params[:label] = { data: label_data }
-      end
-      if @relationships[:attendees]
-        attendees_data = @relationships[:attendees].map { |_id| { id: _id, type: 'user' } }
-        relationhips_params[:attendees] = { data: attendees_data }
-      end
-      {
-        data: { attributes: attributes_params, relationships: relationhips_params }
-      }
-    end
-  end
-
-  class Activity < BaseModel
-    attr_accessor :content
-    attr_accessor :updated_at
-    attr_accessor :created_at
-    attr_accessor :calendar_id
-    attr_accessor :event_id
-
-    TIME_FIELDS = %i[updated_at created_at].freeze
-
-    def create
-      return if @client.nil?
-
-      @client.create_activity calendar_id, event_id, data_params
-    end
-
-    def data_params
-      {
-        data: { attributes: { content: content } }
-      }
-    end
-  end
-end