youcanbookme 0.0.1.alpha

data/lib/youcanbookme/common_module.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module YouCanBookMe
+  # YouCanBook.me utility module.
+  module CommonModule
+    def error_log(msg)
+      log msg, :error
+    end
+
+    def warn_log(msg)
+      log msg, :warn
+    end
+
+    def info_log(msg)
+      log msg, :info
+    end
+
+    def debug_log(msg)
+      log msg, :debug
+    end
+
+    private
+
+    def log(msg, level = :info)
+      logger = YouCanBookMe.configuration.logger
+      return unless logger
+      return unless logger.respond_to? level
+
+      logger.send level, msg
+    end
+  end
+end

data/lib/youcanbookme/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module YouCanBookMe
+  # YouCanBook.me APIs client configuration.
+  class Configuration
+    # @return [String]
+    attr_accessor :account_id
+    # @return [String]
+    attr_accessor :password_or_token
+    # @return [Logger]
+    attr_accessor :logger
+
+    def initialize
+      @logger = Logger.new STDOUT
+      @logger.level = :warn
+    end
+  end
+end

data/lib/youcanbookme/error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module YouCanBookMe
+  # YouCanBookMe module's base error object
+  class Error < StandardError
+    include CommonModule
+
+    def initialize(message = nil)
+      msg = "#{self.class} occured."
+      msg += " message:#{message}"
+      warn_log msg
+      super message
+    end
+  end
+end

data/lib/youcanbookme/http_command.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+module YouCanBookMe
+  # Command for HTTP request.
+  class HttpCommand
+    include CommonModule
+
+    def initialize(account_id, password_or_token, host = nil)
+      @account_id = account_id
+      @password_or_token = password_or_token
+      @host = host || YouCanBookMe::Client::API_HOST
+    end
+
+    #
+    # send GET http request.
+    #
+    # @param [String] path String or URI to access.
+    # @param [Hash] params Hash of URI query unencoded key/value pairs.
+    def get(path, params = {})
+      debug_log "GET #{connection.build_url("#{@host}#{path}", params)}"
+      res = connection.get path, params
+      debug_log "Response status:#{res.status}, body:#{res.body}"
+      res
+    end
+
+    #
+    # send POST http request.
+    #
+    # @param [String] path String or URI to access.
+    # @param [Hash] body_params
+    # The request body that will eventually be converted to JSON.
+    def post(path, body_params = {})
+      debug_log "POST #{@host}#{path} body:#{body_params}"
+      headers = { 'Content-Type' => 'application/json' }
+      res = connection.run_request :post, path, body_params.to_json, headers
+      debug_log "Response status:#{res.status}, body:#{res.body}"
+      res
+    end
+
+    #
+    # send PUT http request.
+    #
+    # @param [String] path String or URI to access.
+    # @param [Hash] body_params
+    # The request body that will eventually be converted to JSON.
+    def put(path, body_params = {})
+      debug_log "PUT #{@host}#{path} body:#{body_params}"
+      headers = { 'Content-Type' => 'application/json' }
+      res = connection.run_request :put, path, body_params.to_json, headers
+      debug_log "Response status:#{res.status}, body:#{res.body}"
+      res
+    end
+
+    #
+    # send PATCH http request.
+    #
+    # @param [String] path String or URI to access.
+    # @param [Hash] body_params
+    # The request body that will eventually be converted to JSON.
+    def patch(path, body_params = {})
+      debug_log "PATCH #{@host}#{path} body:#{body_params}"
+      headers = { 'Content-Type' => 'application/json' }
+      res = connection.run_request :put, path, body_params.to_json, headers
+      debug_log "Response status:#{res.status}, body:#{res.body}"
+      res
+    end
+
+    #
+    # send DELETE http request.
+    #
+    # @param [String] path String or URI to access.
+    # @param [Hash] params Hash of URI query unencoded key/value pairs.
+    def delete(path, params = {})
+      debug_log "DELETE #{@host}#{path} params:#{params}"
+      res = connection.delete path, params
+      debug_log "Response status:#{res.status}, body:#{res.body}"
+      res
+    end
+
+    private
+
+    def connection
+      Faraday.new(
+        url: @host
+      ) do |builder|
+        builder.use Faraday::Request::BasicAuthentication, @account_id, @password_or_token
+        builder.response :json, parser_options: { symbolize_names: true }, content_type: /\bjson$/
+      end
+    end
+  end
+end

data/lib/youcanbookme/models/account.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module YouCanBookMe
+  # YouCanBookMe's Account model.
+  class Account
+    include ModelUtils
+
+    ASSOCIATION = {
+      children: Account,
+      localAccount: CaligraphLocalAccount,
+      parent: Account,
+      profiles: Profile,
+      warnings: Warning
+    }.freeze
+
+    # @return [String]
+    attr_accessor :caligraphKey
+    # @return [Array<YouCanBookMe::Account>]
+    attr_accessor :children
+    # @return [String]
+    attr_accessor :clientState
+    # @return [Boolean]
+    attr_accessor :contactHigh
+    # @return [Boolean]
+    attr_accessor :contactImportant
+    # @return [Boolean]
+    attr_accessor :contactLow
+    # @return [String]
+    attr_accessor :contactMobile
+    # @return [String]
+    attr_accessor :createdAt
+    # @return [Integer]
+    attr_accessor :deleteBookingsAfterDays
+    # @return [Integer]
+    attr_accessor :deletedBookingsCount
+    # @return [String]
+    attr_accessor :email
+    # @return [String]
+    attr_accessor :familyName
+    # @return [Integer]
+    attr_accessor :feeCredit
+    # @return [String]
+    attr_accessor :givenName
+    # @return [String]
+    attr_accessor :gmailAccessToken
+    # @return [String]
+    attr_accessor :gmailAccessTokenExpires
+    # @return [String]
+    attr_accessor :gmailAddress
+    # @return [String]
+    attr_accessor :gmailRefreshToken
+    # @return [Boolean]
+    attr_accessor :googleAppsAccount
+    # @return [Boolean]
+    attr_accessor :gridBranding
+    # @return [Boolean]
+    attr_accessor :hasBookings
+    # @return [String]
+    attr_accessor :id
+    # @return [YouCanBookMe::CaligraphLocalAccount]
+    attr_accessor :localAccount
+    # @return [String]
+    attr_accessor :locale
+    # @return [Account]
+    attr_accessor :loggedIn
+    # @return [String]
+    attr_accessor :organisation
+    # @return [YouCanBookMe::Account]
+    attr_accessor :parent
+    # @return [String]
+    attr_accessor :parentId
+    # @return [Boolean]
+    attr_accessor :privilegedLogin
+    # @return [Array<YouCanBookMe::Profile>]
+    attr_accessor :profiles
+    # @return [String]
+    attr_accessor :realtimeTopic
+    # @return [String]
+    attr_accessor :requestedAction
+    # @return [String]
+    attr_accessor :salesforceAccessToken
+    # @return [String]
+    attr_accessor :salesforceEmailAddress
+    # @return [String]
+    attr_accessor :salesforceInstanceUrl
+    # @return [String]
+    attr_accessor :salesforceRefreshToken
+    # @return [String]
+    attr_accessor :sector
+    # @return [Integer]
+    attr_accessor :smsCredits
+    # @return [String]
+    attr_accessor :stripeAccessToken
+    # @return [String]
+    attr_accessor :stripePublishableKey
+    # @return [String]
+    attr_accessor :stripeRefreshToken
+    # @return [String]
+    attr_accessor :stripeUserId
+    # @return [String]
+    attr_accessor :tags
+    # @return [Boolean]
+    attr_accessor :terms
+    # @return [String]
+    attr_accessor :termsDate
+    # @return [String]
+    attr_accessor :timeZone
+    # @return [String]
+    attr_accessor :uploadCode
+    # @return [Array<YouCanBookMe::Warning>]
+    attr_accessor :warnings
+    # @return [Boolean]
+    attr_accessor :welcomed
+    # @return [String]
+    attr_accessor :zapierKey
+    # @return [String]
+    attr_accessor :zoomAccessToken
+    # @return [String]
+    attr_accessor :zoomAccessTokenExpires
+    # @return [String]
+    attr_accessor :zoomEmailAddress
+    # @return [String]
+    attr_accessor :zoomRefreshToken
+  end
+end

data/lib/youcanbookme/models/action.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module YouCanBookMe
+  # YouCanBookMe's Action model.
+  class Action
+    include ModelUtils
+
+    # @return [String]
+    attr_accessor :accountId
+    # @return [String]
+    attr_accessor :anchor
+    # @return [Boolean]
+    attr_accessor :attachIcs
+    # @return [String]
+    attr_accessor :body
+    # @return [String]
+    attr_accessor :bookingId
+    # @return [String]
+    attr_accessor :cc
+    # @return [String]
+    attr_accessor :created
+    # @return [Integer]
+    attr_accessor :creditsUsed
+    # @return [String]
+    attr_accessor :defaultAsString
+    # @return [Boolean]
+    attr_accessor :deletable
+    # @return [String]
+    attr_accessor :displayFiredAtMediumMedium
+    # @return [String]
+    attr_accessor :displayFiredAtMediumShort
+    # @return [String]
+    attr_accessor :displayFiredAtShortShort
+    # @return [String]
+    attr_accessor :displayLocale
+    # @return [String]
+    attr_accessor :displayTimeZone
+    # @return [String]
+    attr_accessor :displayTypeLong
+    # @return [String]
+    attr_accessor :displayTypeShort
+    # @return [Boolean]
+    attr_accessor :editable
+    # @return [String]
+    attr_accessor :emailId
+    # @return [String]
+    attr_accessor :fireAt
+    # @return [Boolean]
+    attr_accessor :fireAtForceWeekday
+    # @return [String]
+    attr_accessor :firedAt
+    # @return [String]
+    attr_accessor :fromAddress
+    # @return [String]
+    attr_accessor :fromName
+    # @return [String]
+    attr_accessor :id
+    # @return [String]
+    attr_accessor :imageUrl
+    # @return [String]
+    attr_accessor :locale
+    # @return [Integer]
+    attr_accessor :offsetMinutes
+    # @return [String]
+    attr_accessor :parentId
+    # @return [String]
+    attr_accessor :profileId
+    # @return [String]
+    attr_accessor :status
+    # @return [String]
+    attr_accessor :stylingTemplate
+    # @return [String]
+    attr_accessor :subject
+    # @return [String]
+    attr_accessor :timeZone
+    # @return [String]
+    attr_accessor :timeline
+    # @return [String]
+    attr_accessor :title
+    # @return [String]
+    attr_accessor :to
+    # @return [String]
+    attr_accessor :type
+    # @return [String]
+    attr_accessor :updated
+    # @return [Boolean]
+    attr_accessor :withinQuota
+    # @return [Boolean]
+    attr_accessor :ycbmBranded
+  end
+end

data/lib/youcanbookme/models/answer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module YouCanBookMe
+  # YouCanBookMe's Answer model.
+  class Answer
+    include ModelUtils
+
+    ASSOCIATION = {
+      question: Question
+    }.freeze
+
+    # @return [String]
+    attr_accessor :code
+    # @return [YouCanBookMe::Question]
+    attr_accessor :question
+    # @return [String]
+    attr_accessor :string
+  end
+end

data/lib/youcanbookme/models/appointment_type.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module YouCanBookMe
+  class AppointmentType
+    include ModelUtils
+  end
+end

data/lib/youcanbookme/models/booking.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module YouCanBookMe
+  # YouCanBookMe's Booking model.
+  class Booking
+    include ModelUtils
+
+    ASSOCIATION = {
+      actions: Action,
+      answers: Answer,
+      appointmentTypes: ProfileAppointmentType,
+      caligraphEvent: CaligraphEvent,
+      databaseVersion: Booking,
+      lobby: BookingLobby,
+      profile: Profile,
+      services: ProfileAppointmentType,
+      teamMember: ProfileTeamMember
+    }.freeze
+
+    # @return [String]
+    attr_accessor :acceptedAt
+    # @return [String]
+    attr_accessor :accountId
+    # @return [Array<YouCanBookMe::Action>]
+    attr_accessor :actions
+    # @return [Array<YouCanBookMe::Answer>]
+    attr_accessor :answers
+    # @return [Array<String>]
+    attr_accessor :appointmentTypeIds
+    # @return [Array<YouCanBookMe::ProfileAppointmentType>]
+    attr_accessor :appointmentTypes
+    # @return [Array<String>]
+    attr_accessor :appointmentTypesIds
+    # @return [String]
+    attr_accessor :bookerSecret
+    # @return [YouCanBookMe::CaligraphEvent]
+    attr_accessor :caligraphEvent
+    # @return [Boolean]
+    attr_accessor :cancelReasonRequired
+    # @return [Boolean]
+    attr_accessor :cancellable
+    # @return [String]
+    attr_accessor :cancellationCode
+    # @return [String]
+    attr_accessor :cancellationReason
+    # @return [Boolean]
+    attr_accessor :cancelled
+    # @return [String]
+    attr_accessor :cancelledAt
+    # @return [String]
+    attr_accessor :cancelledBy
+    # @return [String]
+    attr_accessor :createdAt
+    # @return [String]
+    attr_accessor :currency
+    # @return [Integer]
+    attr_accessor :currencyFactor
+    # @return [YouCanBookMe::Booking]
+    attr_accessor :databaseVersion
+    # @return [String]
+    attr_accessor :displayBookerEndsAtMediumShort
+    # @return [String]
+    attr_accessor :displayBookerStartsAtMediumShort
+    # @return [String]
+    attr_accessor :displayCreatedAtMedium
+    # @return [String]
+    attr_accessor :displayCreatedAtShortShort
+    # @return [String]
+    attr_accessor :displayDurationFull
+    # @return [String]
+    attr_accessor :displayDurationShort
+    # @return [String]
+    attr_accessor :displayEndsAtMediumShort
+    # @return [String]
+    attr_accessor :displayLocale
+    # @return [String]
+    attr_accessor :displayPrice
+    # @return [String]
+    attr_accessor :displayStartsAtFullShortAndDurationFull
+    # @return [String]
+    attr_accessor :displayStartsAtMediumShort
+    # @return [String]
+    attr_accessor :displayTimeZone
+    # @return [Integer]
+    attr_accessor :durationMinutes
+    # @return [String]
+    attr_accessor :endsAt
+    # @return [String]
+    attr_accessor :endsAtUTC
+    # @return [Integer]
+    attr_accessor :expectedPrice
+    # @return [String]
+    attr_accessor :id
+    # @return [String]
+    attr_accessor :initiatedAt
+    # @return [String]
+    attr_accessor :ip
+    # @return [String]
+    attr_accessor :linkFields
+    # @return [YouCanBookMe::BookingLobby]
+    attr_accessor :lobby
+    # @return [String]
+    attr_accessor :lobbyPassword
+    # @return [String]
+    attr_accessor :locale
+    # @return [Integer]
+    attr_accessor :numberOfSlots
+    # @return [String]
+    attr_accessor :ownerSecret
+    # @return [String]
+    attr_accessor :paymentId
+    # @return [Boolean]
+    attr_accessor :preview
+    # @return [Integer]
+    attr_accessor :price
+    # @return [YouCanBookMe::Profile]
+    attr_accessor :profile
+    # @return [String]
+    attr_accessor :profileAccessCode
+    # @return [String]
+    attr_accessor :profileId
+    # @return [String]
+    attr_accessor :profilePassword
+    # @return [String]
+    attr_accessor :recaptchaResponse
+    # @return [String]
+    attr_accessor :ref
+    # @return [String]
+    attr_accessor :rejectedAt
+    # @return [String]
+    attr_accessor :remoteId
+    # @return [String]
+    attr_accessor :rescheduledAt
+    # @return [String]
+    attr_accessor :rescheduledBy
+    # @return [String]
+    attr_accessor :reviewAt
+    # @return [Array<String>]
+    attr_accessor :serviceIds
+    # @return [Array<YouCanBookMe::ProfileAppointmentType>]
+    attr_accessor :services
+    # @return [String]
+    attr_accessor :startRescheduledFrom
+    # @return [Instant]
+    attr_accessor :startRescheduledFromUTC
+    # @return [String]
+    attr_accessor :startsAt
+    # @return [String]
+    attr_accessor :startsAtUTC
+    # @return [String]
+    attr_accessor :stripeToken
+    # @return [YouCanBookMe::ProfileTeamMember]
+    attr_accessor :teamMember
+    # @return [String]
+    attr_accessor :teamMemberId
+    # @return [String]
+    attr_accessor :tentative
+    # @return [String]
+    attr_accessor :timeZone
+    # @return [String]
+    attr_accessor :timeline
+    # @return [String]
+    attr_accessor :title
+    # @return [Integer]
+    attr_accessor :units
+  end
+end