youcanbookme 0.0.2.alpha → 0.0.3.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3491d5775ccc99d6cd9bf13615ec48e7fcb65d0253b4292e626506b81c49314
-  data.tar.gz: 45f1ca0ad6d5cd1c0bad008f63a4bc8dbc62ec311af7f36ddbd49436c4f2c57c
+  metadata.gz: 7a0923f47ca98e10933774dd975b854f5d14e259e0cb6113e3626bf3cf09603c
+  data.tar.gz: 1bf5f156b9b1e11bbc145245cc8065f964f064c2e9209c3f8c1e12d298bb7fa8
 SHA512:
-  metadata.gz: 65ec8367df8622ae84856c41dcb949437aa37e29ae6987b935b207cb07613f670fdc4c416f0a379bbb17929bd6f6f437e2d53cc0117a2b097551e104146c2242
-  data.tar.gz: cfc49a92911acb2e580895e4c4ffb28c9f52d192b5d2e00b0dd7d791e8539e3a53ce153f5267c36f59cb7d7629e52585740e40c8bc1e6550bf6fe748378b945a
+  metadata.gz: 7b7df64ac8aafaf5f98f65a56fcae4f146071ea0f5fc7932a7495041ef01d01ec7d5b16865bde48ccfd30c785f3b2a51cdaddc6e8ee9fe9af464fdfd528ada53
+  data.tar.gz: b73049cf3e0090a44b3137b0a467c39b3d563698e49d41bc06e81e35024d469c862a9e55f5ef38bd65fac826a7156818e7a2aa2ca39977ab5e40b81cc52b5235

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.0.3.alpha
+
+- support APIs
+  - GET `/v1/{accountId}/bookings`
+  - GET `/v1/{accountId}/profiles/{profileId}/bookings`
+  - GET `/v1/{accountId}/profiles/{profileId}/bookings/{bookingId}`
+
 # 0.0.2.alpha
 
 - support APIs

data/README.md

@@ -37,11 +37,11 @@ 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`
+  - [x] GET `/v1/{accountId}/bookings`
   - [ ] GET `/v1/{accountId}/firedactions`
-  - [ ] GET `/v1/{accountId}/profiles/{profileId}/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`

data/lib/youcanbookme/client.rb

@@ -26,22 +26,89 @@ module YouCanBookMe
     # @param [Array<String>] fields the fields which are included in the response.
     # @return [Account]
     # @since 0.0.1
-    def account(fields = nil)
-      params = set_fields_into_params fields
+    def account(fields: nil)
+      params = build_fields_params fields
       res = @connection.get account_path, params
       Account.new res.body, self
     end
 
+    #
+    # 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 List of Bookings.
+    #
+    # @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 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 Profile by its id.
     #
-    # @param [String] profile_id  the profile's unique 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)
+    def profile(profile_id, fields: nil)
       check_not_empty profile_id, 'profile_id'
-      params = set_fields_into_params fields
+      params = build_fields_params fields
       res = @connection.get profile_path(profile_id), params
       Profile.new res.body, self
     end
@@ -52,15 +119,10 @@ module YouCanBookMe
     # @param [Array<String>] fields the fields which are included in the response.
     # @return [Array<Profile>]
     # @since 0.0.2
-    def profiles(fields = nil)
-      params = set_fields_into_params fields
+    def profiles(fields: nil)
+      params = build_fields_params fields
       res = @connection.get profile_path, params
-      items = res.body
-      unless items.is_a? Array
-        raise YouCanBookMe::Error, 'the response data is not Array.'
-      end
-
-      items.map { |item| Profile.new item, self }
+      map_as_collection res, Profile
     end
 
     #
@@ -99,15 +161,6 @@ module YouCanBookMe
       false
     end
 
-    def set_fields_into_params(fields, params = nil)
-      params ||= {}
-      return params unless fields
-      return params unless fields.is_a? Array
-      return params if fields.empty?
-
-      params.merge(fields: fields.join(','))
-    end
-
     def account_path
       "/#{API_VERSION}/#{@account_id}"
     end
@@ -118,5 +171,37 @@ module YouCanBookMe
 
       "#{path}/#{profile_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 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
+      return params if fields.empty?
+
+      params.merge(fields: fields.join(','))
+    end
+
+    def map_as_collection(response, klass)
+      items = response.body
+      unless items.is_a? Array
+        raise YouCanBookMe::Error, 'the response data is not Array.'
+      end
+
+      items.map { |item| klass.new item, self }
+    end
   end
 end

data/lib/youcanbookme/error.rb

@@ -3,7 +3,7 @@
 module YouCanBookMe
   # YouCanBookMe module's base error object
   class Error < StandardError
-    include CommonModule
+    include Loggable
 
     def initialize(message = nil)
       msg = "#{self.class} occured."

data/lib/youcanbookme/http_command.rb

@@ -6,7 +6,7 @@ require 'faraday_middleware'
 module YouCanBookMe
   # Command for HTTP request.
   class HttpCommand
-    include CommonModule
+    include Loggable
 
     def initialize(account_id, password_or_token, host = nil)
       @account_id = account_id

data/lib/youcanbookme/{common_module.rb → loggable.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module YouCanBookMe
-  # YouCanBook.me utility module.
-  module CommonModule
+  # YouCanBook.me logger utility module.
+  module Loggable
     def error_log(msg)
       log msg, :error
     end

data/lib/youcanbookme/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YouCanBookMe
-  VERSION = '0.0.2.alpha'
+  VERSION = '0.0.3.alpha'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: youcanbookme
 version: !ruby/object:Gem::Version
-  version: 0.0.2.alpha
+  version: 0.0.3.alpha
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -157,10 +157,10 @@ files:
 - bin/setup
 - lib/youcanbookme.rb
 - lib/youcanbookme/client.rb
-- lib/youcanbookme/common_module.rb
 - lib/youcanbookme/configuration.rb
 - lib/youcanbookme/error.rb
 - lib/youcanbookme/http_command.rb
+- lib/youcanbookme/loggable.rb
 - lib/youcanbookme/models/account.rb
 - lib/youcanbookme/models/action.rb
 - lib/youcanbookme/models/answer.rb
@@ -221,7 +221,7 @@ metadata:
   homepage_uri: https://github.com/koshilife/youcanbookme-api-ruby-client
   source_code_uri: https://github.com/koshilife/youcanbookme-api-ruby-client
   changelog_uri: https://github.com/koshilife/youcanbookme-api-ruby-client/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/youcanbookme/0.0.2.alpha
+  documentation_uri: https://www.rubydoc.info/gems/youcanbookme/0.0.3.alpha
 post_install_message: 
 rdoc_options: []
 require_paths: