youcanbookme 0.0.1.alpha → 0.0.6.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36f53dab6a17b2b18709b2b46f3b57bee4b27bced5172e1b5b1b478ef930a5ee
-  data.tar.gz: 7dcd566aa70a702c9fac08b16c8be40006588e1902620be6d9460f68b38f0c8c
+  metadata.gz: 220fc0b04f4037f4daa16043fba1337cdd69817f406ae3cc3dda763409f0d299
+  data.tar.gz: 398dad8620738536ad7be8ae689eee0683b710c5737083f5f8e3db57efb36aa4
 SHA512:
-  metadata.gz: 86cf465f68b4b4d183504f0e5ef0d8cb814fcab79f8e1d8c6935abbf0f2c184d1f073b6026c4d8d3f5ea23b85f7e2756f6511924a1e547476d91956b6d8f08b1
-  data.tar.gz: 469f6024831bf01e032b14b4bb63d5232fc682cf11522f141536a05da78524f25765ded2c259e0bd910994b0625c4d2b9c39a8a1c54f79efefe0ab0e034e4de4
+  metadata.gz: 572f0f500445237217e6953142531944efe96e98f452811d774e3d0d9d324e0981105a31fa7a3ebf5dd4aeb6aeafb56caf9719065a35319296bb5c3b6444a974
+  data.tar.gz: d72e03f30af127d22ba90a78a00797aab82a1efd670958b3cfbda5dd0f02cbc145a21f3cd5bb77d61826b20a503e0ae0d8bc4e6c02816321f63437afd53b4a1a

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

@@ -23,12 +23,12 @@ Metrics/BlockNesting:
   Max: 2
 
 Layout/LineLength:
- AllowURI: true
- Enabled: false
+  AllowURI: true
+  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,7 +1,42 @@
-# 0.0.1.alpha
+# CHANGELOG
+
+## 0.0.6.alpha
+
+- support APIs below.
+  - GET `/v1/{accountId}/remoteaccounts/{remoteAccountId}/calendars`
+  - GET `/v1/{accountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}`
+  - GET `/v1/{accountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}/events/{eventId}`
+
+## 0.0.5.alpha
+
+- support APIs below.
+  - GET `/v1/{accountId}/remoteaccounts`
+  - GET `/v1/{accountId}/remoteaccounts/{remoteAccountId}`
+
+## 0.0.4.alpha
+
+redefine models in order to follow changed APIs below.
+
+- LocalAccount was merged into Account.
+- Caligraph APIs were removed.
+
+## 0.0.3.alpha
+
+- support APIs below.
+  - GET `/v1/{accountId}/bookings`
+  - GET `/v1/{accountId}/profiles/{profileId}/bookings`
+  - GET `/v1/{accountId}/profiles/{profileId}/bookings/{bookingId}`
+
+## 0.0.2.alpha
+
+- support APIs below.
+  - GET `/v1/{accountId}/profiles`
+  - GET `/v1/{accountId}/profiles/{profileId}`
+
+## 0.0.1.alpha
 
 - Initial release.
-- support APIs
+- support APIs below.
   - GET `/v1/{accountId}`
   - GET `/v1/subdomains/{subdomain}`
   - GET `/v1/suggestedsubdomains`

data/README.md

@@ -37,45 +37,42 @@ Or install it yourself as:
   - [ ] PATCH `/v1/{accountId}/profiles/{profileId}/appointmenttypes/items/{appointmentTypeId}`
   - [ ] DELETE `/v1/{accountId}/profiles/{profileId}/appointmenttypes/items/{appointmentTypeId}`
 - Bookings:
-  - [ ] GET `/v1/{accountId}/bookings`
-  - [ ] GET `/v1/{accountId}/firedactions`
-  - [ ] GET `/v1/{accountId}/profiles/{profileId}/bookings`
+  - [x] GET `/v1/{accountId}/bookings`
+  - [x] GET `/v1/{accountId}/profiles/{profileId}/bookings`
   - [ ] POST `/v1/{accountId}/profiles/{profileId}/bookings`
-  - [ ] GET `/v1/{accountId}/profiles/{profileId}/bookings/{bookingId}`
+  - [x] GET `/v1/{accountId}/profiles/{profileId}/bookings/{bookingId}`
   - [ ] PATCH `/v1/{accountId}/profiles/{profileId}/bookings/{bookingId}`
   - [ ] DELETE `/v1/{accountId}/profiles/{profileId}/bookings/{bookingId}`
-  - [ ] GET `/v1/{accountId}/profiles/{profileId}/firedactions`
   - [ ] GET `/v1/ics/{bookingSecret}/{bookingIdOrRef}.ics`
-  - [ ] GET `/v1/profiles/{profileIdOrSubdomain}/bookings/{bookingIdOrRef}/lobby`
-  - [ ] (Deprecated) GET `/v1/ics/{bookingRef}`
-  - [ ] (Deprecated) GET `/v1/ics/{bookingRef}.ics`
 - Calendars:
-  - [ ] GET `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars`
-  - [ ] POST `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars`
-  - [ ] GET `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}`
-  - [ ] PUT `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}`
-  - [ ] PATCH `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}`
-  - [ ] DELETE `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}`
+  - [x] GET `/v1/{accountId}/remoteaccounts/{remoteAccountId}/calendars`
+  - [ ] POST `/v1/{accountId}/remoteaccounts/{remoteAccountId}/calendars`
+  - [x] GET `/v1/{accountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}`
+  - [ ] PUT `/v1/{accountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}`
+  - [ ] PATCH `/v1/{accountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}`
+  - [ ] DELETE `/v1/{accountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}`
 - Events:
-  - [ ] POST `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}/events`
-  - [ ] GET `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}/events/{eventId}`
-  - [ ] DELETE `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}/events/{eventId}`
+  - [ ] POST `/v1/{accountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}/events`
+  - [x] GET `/v1/{accountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}/events/{eventId}`
+  - [ ] PATCH `/v1/{accountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}/events/{eventId}`
+  - [ ] DELETE `/v1/{accountId}/remoteaccounts/{remoteAccountId}/calendars/{calendarId}/events/{eventId}`
 - Profile
-  - [ ] GET `/v1/{accountId}/profiles`
+  - [x] GET `/v1/{accountId}/profiles`
   - [ ] POST `/v1/{accountId}/profiles`
-  - [ ] GET `/v1/{accountId}/profiles/{profileId}`
+  - [x] GET `/v1/{accountId}/profiles/{profileId}`
   - [ ] PATCH `/v1/{accountId}/profiles/{profileId}`
   - [ ] DELETE `/v1/{accountId}/profiles/{profileId}`
+  - [ ] GET `/v1/{accountId}/profiles/{profileId}/suggestedactions`
   - [x] GET `/v1/subdomains/{subdomain}`
   - [x] GET `/v1/suggestedsubdomains`
 - Query
-  - [ ] POST `/v1/{localAccountId}/queries`
+  - [ ] POST `/v1/{accountId}/queries`
 - Remote Account
-  - [ ] GET `/v1/{localAccountId}/remoteaccounts`
-  - [ ] POST `/v1/{localAccountId}/remoteaccounts`
-  - [ ] GET `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}`
-  - [ ] PATCH `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}`
-  - [ ] DELETE `/v1/{localAccountId}/remoteaccounts/{remoteAccountId}`
+  - [x] GET `/v1/{accountId}/remoteaccounts`
+  - [ ] POST `/v1/{accountId}/remoteaccounts`
+  - [x] GET `/v1/{accountId}/remoteaccounts/{remoteAccountId}`
+  - [ ] PATCH `/v1/{accountId}/remoteaccounts/{remoteAccountId}`
+  - [ ] DELETE `/v1/{accountId}/remoteaccounts/{remoteAccountId}`
 - Team Members:
   - [ ] POST `/v1/{accountId}/profiles/{profileId}/teammembers/items`
   - [ ] PATCH `/v1/{accountId}/profiles/{profileId}/teammembers/items/{teamMemberId}`

data/lib/youcanbookme/client.rb

@@ -2,7 +2,7 @@
 
 module YouCanBookMe
   # YouCanBookMe APIs client.
-  class Client
+  class Client # rubocop:disable Metrics/ClassLength
     API_HOST = 'https://api.youcanbook.me'
     API_VERSION = 'v1'
 
@@ -21,28 +21,166 @@ module YouCanBookMe
     end
 
     #
-    # Account
+    # Get basic information about current account.
     #
+    # @param [Array<String>] fields the fields which are included in the response.
+    # @return [Account]
+    # @since 0.0.1
+    def account(fields: nil)
+      params = build_fields_params fields
+      res = @connection.get account_path, params
+      Account.new res.body, self
+    end
 
-    def account_path
-      "/#{API_VERSION}/#{@account_id}"
+    #
+    # Returns a single Booking by associated ids.
+    #
+    # @param [String] profile_id the profile's unique id.
+    # @param [String] booking_id the booking's unique id.
+    # @param [Array<String>] fields the fields which are included in the response.
+    # @param [Hash] options the optional request parameters.
+    # @option options [String] :bsec
+    # @option options [String] :displayTimeZone
+    # @option options [String] :osec
+    # @return [Booking]
+    # @since 0.0.3
+    def booking(profile_id, booking_id, fields: nil, options: nil)
+      check_not_empty profile_id, 'profile_id'
+      check_not_empty booking_id, 'booking_id'
+      path = booking_path profile_id, booking_id
+      opts_keys = %i[bsec displayTimeZone osec]
+      params = build_option_params options, opts_keys, fields: fields
+      res = @connection.get path, params
+      Booking.new res.body, self
     end
 
     #
-    # Get basic information about current account.
+    # Get List of Bookings.
     #
     # @param [Array<String>] fields the fields which are included in the response.
-    # @return [Account]
-    def account(fields = nil)
-      params = set_fields_into_params(fields)
-      res = @connection.get account_path, params
-      Account.new res.body, self
+    # @param [Hash] options the optional request parameters.
+    # @option options [String] :boundaryId
+    # @option options [String] :boundaryStartsAt
+    # @option options [String] :direction
+    # @option options [String] :displayTimeZone
+    # @option options [String] :jumpToDate
+    # @option options [String] :profileIds
+    # @option options [String] :search
+    # @return [Array<Booking>]
+    # @since 0.0.3
+    def bookings(fields: nil, options: nil)
+      opts_keys = %i[boundaryId boundaryStartsAt direction displayTimeZone jumpToDate profileIds search]
+      params = build_option_params options, opts_keys, fields: fields
+      res = @connection.get booking_path, params
+      map_as_collection res, Booking
+    end
+
+    #
+    # Get List of Bookings associated by profile_id.
+    #
+    # @param [String] profile_id the profile's unique id.
+    # @param [Array<String>] fields the fields which are included in the response.
+    # @param [Hash] options the optional request parameters.
+    # @option options [String] :boundaryId
+    # @option options [String] :boundaryStartsAt
+    # @option options [String] :direction
+    # @option options [String] :displayTimeZone
+    # @option options [String] :jumpToDate
+    # @option options [String] :profileIds
+    # @option options [String] :search
+    # @return [Array<Booking>]
+    # @since 0.0.3
+    def profile_bookings(profile_id, fields: nil, options: nil)
+      check_not_empty profile_id, 'profile_id'
+      path = booking_path profile_id
+      opts_keys = %i[boundaryId boundaryStartsAt direction displayTimeZone jumpToDate profileIds search]
+      params = build_option_params options, opts_keys, fields: fields
+      res = @connection.get path, params
+      map_as_collection res, Booking
+    end
+
+    #
+    # Returns a single Calendar by its id.
+    #
+    # @param [String] remote_account_id the remote_account's unique id.
+    # @param [String] calendar_id the calendar's unique id.
+    # @param [Array<String>] fields the fields which are included in the response.
+    # @return [Calendar]
+    # @since 0.0.6
+    def calendar(remote_account_id, calendar_id, fields: nil)
+      check_not_empty remote_account_id, 'remote_account_id'
+      check_not_empty calendar_id, 'calendar_id'
+      params = build_fields_params fields
+      path = calendar_path remote_account_id, calendar_id
+      res = @connection.get path, params
+      Calendar.new res.body, self
+    end
+
+    #
+    # Get List of Calendar.
+    #
+    # @param [String] remote_account_id the remote_account's unique id.
+    # @param [Array<String>] fields the fields which are included in the response.
+    # @return [Array<Calendar>]
+    # @since 0.0.6
+    def calendars(remote_account_id, fields: nil)
+      check_not_empty remote_account_id, 'remote_account_id'
+      params = build_fields_params fields
+      path = calendar_path remote_account_id
+      res = @connection.get path, params
+      map_as_collection res, Calendar
+    end
+
+    #
+    # Returns a single Event by its id.
+    #
+    # @param [String] remote_account_id the remote_account's unique id.
+    # @param [String] calendar_id the calendar's unique id.
+    # @param [String] event_id the event's unique id.
+    # @param [Array<String>] fields the fields which are included in the response.
+    # @return [Event]
+    # @since 0.0.6
+    def event(remote_account_id, calendar_id, event_id, fields: nil)
+      check_not_empty remote_account_id, 'remote_account_id'
+      check_not_empty calendar_id, 'calendar_id'
+      check_not_empty event_id, 'event_id'
+      params = build_fields_params fields
+      path = event_path remote_account_id, calendar_id, event_id
+      res = @connection.get path, params
+      Event.new res.body, self
+    end
+
+    #
+    # Returns a single Profile by its id.
+    #
+    # @param [String] profile_id the profile's unique id.
+    # @param [Array<String>] fields the fields which are included in the response.
+    # @return [Profile]
+    # @since 0.0.2
+    def profile(profile_id, fields: nil)
+      check_not_empty profile_id, 'profile_id'
+      params = build_fields_params fields
+      res = @connection.get profile_path(profile_id), params
+      Profile.new res.body, self
+    end
+
+    #
+    # Get List of Profile.
+    #
+    # @param [Array<String>] fields the fields which are included in the response.
+    # @return [Array<Profile>]
+    # @since 0.0.2
+    def profiles(fields: nil)
+      params = build_fields_params fields
+      res = @connection.get profile_path, params
+      map_as_collection res, Profile
     end
 
     #
     # Get suggested subdomains
     #
     # @return [Array<String>]
+    # @since 0.0.1
     def suggested_subdomains
       res = @connection.get "/#{API_VERSION}/suggestedsubdomains"
       res.body
@@ -54,16 +192,45 @@ module YouCanBookMe
     # @param [String] subdomain
     # @return [Boolean]
     # @raise [YouCanBookMe::Error] if the subdomain arg is empty.
+    # @since 0.0.1
     def subdomain_available?(subdomain)
       check_not_empty subdomain, 'subdomain'
       res = @connection.get "/#{API_VERSION}/subdomains/#{subdomain}"
       res.body[:free]
     end
 
-    private
+    #
+    # Returns a single RemoteAccount by its id.
+    #
+    # @param [String] remote_account_id the remote account's unique id.
+    # @param [Array<String>] fields the fields which are included in the response.
+    # @return [YouCanBookMe::RemoteAccount]
+    # @raise [YouCanBookMe::Error] if the subdomain arg is empty.
+    # @since 0.0.5
+    def remote_account(remote_account_id, fields: nil)
+      check_not_empty remote_account_id, 'remote_account_id'
+      params = build_fields_params fields
+      path = remote_account_path(remote_account_id)
+      res = @connection.get path, params
+      RemoteAccount.new res.body, self
+    end
+
+    #
+    # Get List of Remote Account.
+    #
+    # @param [Array<String>] fields the fields which are included in the response.
+    # @return [Array<YouCanBookMe::RemoteAccount>]
+    # @since 0.0.5
+    def remote_accounts(fields: nil)
+      params = build_fields_params fields
+      res = @connection.get remote_account_path, params
+      map_as_collection res, RemoteAccount
+    end
+
+  private
 
     def check_not_empty(value, name)
-      raise YouCanBookMe::Error, "#{name} is required." if blank? value
+      raise YouCanBookMe::Error.new("#{name} is required.") if blank? value
     end
 
     def blank?(value)
@@ -73,7 +240,55 @@ module YouCanBookMe
       false
     end
 
-    def set_fields_into_params(fields, params = nil)
+    def account_path
+      "/#{API_VERSION}/#{@account_id}"
+    end
+
+    def booking_path(profile_id = nil, booking_id = nil)
+      return "#{account_path}/bookings" unless profile_id
+
+      path = "#{profile_path(profile_id)}/bookings"
+      return path unless booking_id
+
+      "#{path}/#{booking_id}"
+    end
+
+    def calendar_path(remote_account_id, calendar_id = nil)
+      remote_path = remote_account_path remote_account_id
+      path = "#{remote_path}/calendars"
+      return path unless calendar_id
+
+      "#{path}/#{calendar_id}"
+    end
+
+    def event_path(remote_account_id, calendar_id, event_id = nil)
+      cal_path = calendar_path remote_account_id, calendar_id
+      path = "#{cal_path}/events"
+      return path unless event_id
+
+      "#{path}/#{event_id}"
+    end
+
+    def profile_path(profile_id = nil)
+      path = "#{account_path}/profiles"
+      return path unless profile_id
+
+      "#{path}/#{profile_id}"
+    end
+
+    def remote_account_path(remote_account_id = nil)
+      path = "#{account_path}/remoteaccounts"
+      return path unless remote_account_id
+
+      "#{path}/#{remote_account_id}"
+    end
+
+    def build_option_params(options, filters, fields: nil)
+      options ||= {}
+      build_fields_params fields, options.slice(*filters)
+    end
+
+    def build_fields_params(fields, params = nil)
       params ||= {}
       return params unless fields
       return params unless fields.is_a? Array
@@ -81,5 +296,12 @@ module YouCanBookMe
 
       params.merge(fields: fields.join(','))
     end
+
+    def map_as_collection(response, klass)
+      items = response.body
+      raise YouCanBookMe::Error.new('the response data is not Array.') unless items.is_a? Array
+
+      items.map { |item| klass.new item, self }
+    end
   end
 end