cronofy 0.31.2 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ac0a6d45f99b6fc43669a1c8bfae0ae9c040d05ca200c9638cf535fcff3ee71
-  data.tar.gz: 44ce008bc883118eda39dc75a486834083e71bfb37ff2716629db2d9019578ed
+  metadata.gz: 8f29c174e71afa774e39cc40e852e3c95b60135bf076596adebfa302d0b1457d
+  data.tar.gz: e41e9a034f53aea943c74e9cff922713beda7edc9fb3d765ee2a31481ce6d236
 SHA512:
-  metadata.gz: e9e8ff68fbfa8a4fe9582a259dd885f3d8cd155ec455fccbdab736acc3fdfae655ce2ec17eeb81a954774a6c311172c28d0be24721179ef408b08bb060b3fe9d
-  data.tar.gz: 3f0632f1a75377bcbcca43fbe03557c91dff7492ed1122688bd160e7c5227c0620c0b8765f46cbac54fe53aafb8fd6d2b224fbb07beee41d7d67d3358e7a3b73
+  metadata.gz: d8263c12831f387bdbc43bdb754f2546bcdefba7021a834d556c07620f0c7f67a85dddf37ac7b70f052750bba8ef247680b0ac5843a3c00025283112d38bd205
+  data.tar.gz: 4648a9b821c575337165a2d395d85b359a5d882184dc17bff41ae9e792a37d62b048e2b610d185b06d80ccd20abe8ba15e8f0e3b27187b11ff25ca7518cf6879

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.32.0]
+
+ * Support Availability Rules and Scheduling Conversations [#64]
+
 ## [0.31.2]
 
  * Support parsing new Availability response formats [#73]
@@ -142,6 +146,7 @@
 [0.31.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.31.0
 [0.31.1]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.31.1
 [0.31.2]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.31.2
+[0.32.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.32.0
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -174,6 +179,7 @@
 [#59]: https://github.com/cronofy/cronofy-ruby/pull/59
 [#60]: https://github.com/cronofy/cronofy-ruby/pull/60
 [#62]: https://github.com/cronofy/cronofy-ruby/pull/62
+[#64]: https://github.com/cronofy/cronofy-ruby/pull/64
 [#69]: https://github.com/cronofy/cronofy-ruby/pull/69
 [#72]: https://github.com/cronofy/cronofy-ruby/pull/72
 [#73]: https://github.com/cronofy/cronofy-ruby/pull/73

data/lib/cronofy/client.rb

@@ -1344,7 +1344,6 @@ module Cronofy
       parse_json(SmartInviteResponse, nil, response)
     end
 
-
     # Public: Creates an element_token to pass to a UI Element
     #
     # options     - A Hash of options for the token
@@ -1371,6 +1370,133 @@ module Cronofy
       parse_json(ElementToken, "element_token", response)
     end
 
+    # Public: Creates or updates an AvailabilityRule.
+    #
+    # availability_rule_id - A String uniquely identifying the availability rule
+    #                        for the authenticated user in your application
+    #                        (note: this is NOT an ID generated by Cronofy).
+    # tzid            - The time zone identifier for the rule.
+    # calendar_ids    - An optional array of calendar_ids that should impact the
+    #                   user's availability.
+    # weekly_periods  - An array of objects describing a weekly recurring available period
+    #                 :day        - A String for the week day
+    #                 :start_time - A String for 24hr time that period starts eg: 09:30
+    #                 :end_time   - A String for 24hr time that period ends eg: 17:30
+    # Examples
+    #
+    #   client.upsert_availability_rule(
+    #     availability_rule_id: "qTtZdczOccgaPncGJaCiLg",
+    #     tzid: "America/Chicago",
+    #     calendar_ids: [
+    #       "cal_n23kjnwrw2_jsdfjksn234"
+    #     ],
+    #     weekly_periods: [
+    #       {
+    #         day: "monday",
+    #         start_time: "09:30",
+    #         end_time: "12:30",
+    #       },
+    #       {
+    #         day: "tuesday",
+    #         start_time: "09:30",
+    #         end_time: "12:30",
+    #       }
+    #     ]
+    #   )
+    #
+    # See http://www.cronofy.com/developers/alpha/api#availability_rules for reference.
+    #
+    # Returns an AvailabilityRuleResponse.
+    #
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    # Raises Cronofy::InvalidRequestError if the request contains invalid
+    # parameters.
+    # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
+    # limits for the application.
+    def upsert_availability_rule(body)
+      response = wrapped_request { post("/v1/availability_rules", body) }
+      parse_json(AvailabilityRule, 'availability_rule', response)
+    end
+
+    # Public: Gets an AvailabilityRule.
+    #
+    # availability_rule_id - A String uniquely identifying the availability rule
+    #                        for the authenticated user in your application
+    #
+    # Returns an AvailabilityRuleResponse.
+    #
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    # Raises Cronofy::InvalidRequestError if the request contains invalid
+    # parameters.
+    # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
+    # limits for the application.
+    def get_availability_rule(availability_rule_id)
+      response = wrapped_request { get("/v1/availability_rules/#{availability_rule_id}") }
+      parse_json(AvailabilityRule, 'availability_rule', response)
+    end
+
+    # Public: Deletes an AvailabilityRule.
+    #
+    # availability_rule_id - A String uniquely identifying the availability rule
+    #                        for the authenticated user in your application
+    #
+    # Returns nothing.
+    #
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    # Raises Cronofy::InvalidRequestError if the request contains invalid
+    # parameters.
+    # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
+    # limits for the application.
+    def delete_availability_rule(availability_rule_id)
+      wrapped_request { delete("/v1/availability_rules/#{availability_rule_id}") }
+      nil
+    end
+
+    # Public: Creates a scheduling conversation
+    #
+    # pre release end-point documentation to follow
+    #
+    def create_scheduling_conversation(body)
+      response = wrapped_request { post("/v1/scheduling_conversations", body) }
+      parse_json(SchedulingConversation, 'scheduling_conversation', response)
+    end
+
+    # Public: Creates a scheduling conversation
+    #
+    # pre release end-point documentation to follow
+    #
+    def get_scheduling_conversation(id)
+      response = wrapped_request { get("/v1/scheduling_conversations/#{id}") }
+      parse_json(SchedulingConversation, 'scheduling_conversation', response)
+    end
+
+    # Public: Looks up a scheduling conversation with a token returned by a redirect
+    #
+    # pre release end-point documentation to follow
+    #
+    def lookup_scheduling_conversation(token)
+      response = wrapped_request { get("/v1/scheduling_conversations?token=#{token}") }
+      parse_json(SchedulingConversationResponse, nil, response)
+    end
+
+    # Public: List available slots for a scheduling conversation
+    #
+    # pre release end-point documentation to follow
+    #
+    def list_scheduling_conversation_participant_slots(url)
+      response = wrapped_request { get(url) }
+      parse_collection(SchedulingConversationSlot, "slots", response )
+    end
+
+    # Public: Choose one or more slots for a scheduling conversation
+    #
+    # pre release end-point documentation to follow
+    #
+    def select_scheduling_conversation_participant_slots(url, args)
+      response = wrapped_request { post(url, args)}
+      parse_json(SchedulingConversation, 'scheduling_conversation', response)
+    end
+
     private
 
     def translate_available_periods(periods)

data/lib/cronofy/types.rb

@@ -387,4 +387,30 @@ module Cronofy
 
   class ElementToken < CronofyMash
   end
+
+  class SchedulingConversation < CronofyMash
+  end
+
+  class SchedulingConversationResponse < CronofyMash
+    coerce_key :participant, Participant
+    coerce_key :scheduling_conversation, SchedulingConversation
+  end
+
+  class SchedulingConversationSlot < CronofyMash
+    coerce_key :start, EventTime
+    coerce_key :end, EventTime
+  end
+
+  class WeeklyPeriod < CronofyMash
+  end
+
+  module WeeklyPeriodEnumerable
+    def self.coerce(values)
+      values.map { |v| WeeklyPeriod.new(v) }
+    end
+  end
+
+  class AvailabilityRule < CronofyMash
+    coerce_key :weekly_periods, WeeklyPeriodEnumerable
+  end
 end

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.31.2".freeze
+  VERSION = "0.32.0".freeze
 end

data/spec/lib/cronofy/client_spec.rb

@@ -2841,4 +2841,204 @@ describe Cronofy::Client do
       end
     end
   end
+
+  describe '#create_scheduling_conversation' do
+    let(:request_url) { 'https://api.cronofy.com/v1/scheduling_conversations' }
+    let(:method) { :post }
+    let(:request_body) do
+      {
+        "participants" => [
+          {
+            "participant_id" => "@grace",
+            "sub" => "acc_567236000909002",
+            "slots" => {
+              "choice_method" => "auto"
+            }
+          },
+          {
+            "participant_id" => "@karl"
+          }
+        ],
+        "required_duration" => { "minutes" => 60 },
+        "available_periods" => [
+          {
+            "start" => "2018-05-01T00:00:00Z",
+            "end" => "2018-05-08T23:59:59Z"
+          }
+        ]
+      }
+    end
+
+    let(:correct_response_code) { 200 }
+    let(:correct_response_body) do
+      {
+        "scheduling_conversation" => {
+          "scheduling_conversation_id" => "abcd1234"
+        }
+      }
+    end
+
+    let(:correct_mapped_result) do
+      Cronofy::SchedulingConversation.new(scheduling_conversation_id: "abcd1234")
+    end
+
+    subject { client.create_scheduling_conversation(request_body) }
+
+    it_behaves_like 'a Cronofy request'
+    it_behaves_like 'a Cronofy request with mapped return value'
+  end
+
+  describe '#lookup_scheduling_conversation' do
+    let(:token) { "hagsdau7g3d" }
+    let(:request_url) { "https://api.cronofy.com/v1/scheduling_conversations?token=#{token}" }
+    let(:method) { :get }
+
+    let(:correct_response_code) { 200 }
+    let(:correct_response_body) do
+      {
+        "participant" => {
+          "participant_id" => "83o38hoa"
+        },
+        "scheduling_conversation" => {
+          "scheduling_conversation_id" => "abcd1234"
+        },
+      }
+    end
+
+    let(:correct_mapped_result) do
+      Cronofy::SchedulingConversationResponse.new(
+        participant: Cronofy::Participant.new(participant_id: "83o38hoa"),
+        scheduling_conversation: Cronofy::SchedulingConversation.new(scheduling_conversation_id: "abcd1234"),
+        )
+    end
+
+    subject { client.lookup_scheduling_conversation(token) }
+
+    it_behaves_like 'a Cronofy request'
+    it_behaves_like 'a Cronofy request with mapped return value'
+  end
+
+  describe '#upsert_availability_rule' do
+    let(:request_url) { 'https://api.cronofy.com/v1/availability_rules' }
+    let(:method) { :post }
+    let(:request_body) do
+      {
+        "availability_rule_id" => "default",
+        "tzid" => "America/Chicago",
+        "calendar_ids" => [
+          "cal_n23kjnwrw2_jsdfjksn234"
+        ],
+        "weekly_periods" => [
+          {
+            "day" => "monday",
+            "start_time" => "09:30",
+            "end_time" => "16:30"
+          },
+          {
+            "day" => "wednesday",
+            "start_time" => "09:30",
+            "end_time" => "16:30"
+          }
+        ]
+      }
+    end
+
+    let(:correct_response_code) { 200 }
+    let(:correct_response_body) do
+      {
+        "availability_rule" => {
+          "availability_rule_id" => "default",
+          "tzid" => "America/Chicago",
+          "calendar_ids" => [
+            "cal_n23kjnwrw2_jsdfjksn234"
+          ],
+          "weekly_periods" => [
+            {
+              "day" => "monday",
+              "start_time" => "09:30",
+              "end_time" => "16:30"
+            },
+            {
+              "day" => "wednesday",
+              "start_time" => "09:30",
+              "end_time" => "16:30"
+            }
+          ]
+        }
+      }
+    end
+
+    let(:correct_mapped_result) do
+      Cronofy::AvailabilityRule.new(
+        availability_rule_id: request_body['availability_rule_id'],
+        tzid: request_body['tzid'],
+        calendar_ids: request_body['calendar_ids'],
+        weekly_periods: request_body['weekly_periods'].map { |wp| Cronofy::WeeklyPeriod.new(wp) },
+        )
+    end
+
+    subject { client.upsert_availability_rule(request_body) }
+
+    it_behaves_like 'a Cronofy request'
+    it_behaves_like 'a Cronofy request with mapped return value'
+  end
+
+  describe "#get_availability_rule" do
+    let(:availability_rule_id) { 'default'}
+    let(:request_url) { "https://api.cronofy.com/v1/availability_rules/#{availability_rule_id}" }
+    let(:method) { :get }
+
+    let(:correct_response_code) { 200 }
+    let(:correct_response_body) do
+      {
+        "availability_rule" => {
+          "availability_rule_id" => "default",
+          "tzid" => "America/Chicago",
+          "calendar_ids" => [
+            "cal_n23kjnwrw2_jsdfjksn234"
+          ],
+          "weekly_periods" => [
+            {
+              "day" => "monday",
+              "start_time" => "09:30",
+              "end_time" => "16:30"
+            },
+            {
+              "day" => "wednesday",
+              "start_time" => "09:30",
+              "end_time" => "16:30"
+            }
+          ]
+        }
+      }
+    end
+
+    let(:correct_mapped_result) do
+      rule = correct_response_body['availability_rule']
+      Cronofy::AvailabilityRule.new(
+        availability_rule_id: rule['availability_rule_id'],
+        tzid: rule['tzid'],
+        calendar_ids: rule['calendar_ids'],
+        weekly_periods: rule['weekly_periods'].map { |wp| Cronofy::WeeklyPeriod.new(wp) },
+        )
+    end
+
+    subject { client.get_availability_rule(availability_rule_id) }
+
+    it_behaves_like 'a Cronofy request'
+    it_behaves_like 'a Cronofy request with mapped return value'
+  end
+
+  describe '#delete_availability_rule' do
+    let(:availability_rule_id) { 'default'}
+    let(:request_url) { "https://api.cronofy.com/v1/availability_rules/#{availability_rule_id}" }
+    let(:method) { :delete }
+    let(:request_body) { nil }
+    let(:correct_response_code) { 202 }
+    let(:correct_response_body) { nil }
+
+    subject { client.delete_availability_rule(availability_rule_id) }
+
+    it_behaves_like 'a Cronofy request'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.31.2
+  version: 0.32.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-11 00:00:00.000000000 Z
+date: 2019-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2