cronofy 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 522370b2f01af27ff60bacbb76323ca47dd077b1
-  data.tar.gz: 716a6013058ba2216fe70ac96b755bc6533ba24e
+  metadata.gz: 0b09683a6a1a610a1f4e0790c918b85a403676e4
+  data.tar.gz: d79520d6abb9e4c51d07b0dc59eb020205c61624
 SHA512:
-  metadata.gz: b8bdf1cbb735736f76700aad41b083be051b5d821e03a088c54b537c066743ee51390fc73daa6875b8ecc78ee22e5c6c127d8b94532ee3af0b492cd4270b8acf
-  data.tar.gz: 5bb3db55ed8cd3e9f71320bdb13f1e754d9f9bf47b049d8d87c3a2be74fc668c4c21c0f352fb4147ef1bd54762b39c03e2f004b6ade724ba9ff3f0011b4c04fb
+  metadata.gz: f1f7adbeaa413a282fd1d930984b9d52215326959ff3f62f690dade3210ac2f98af7701e3fc2a1975373b8275c0b0120cddf3f0cd653588309a9898089a3c0d4
+  data.tar.gz: ccb144468e56a76d91f1917647e8e0f405fa9493d66fb517d274d846acfaa418465ce052defba90e9d999e3a0734caa720c31e815a9f2cf2982f17db19b12317

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.21.0]
+
+ * Support Add To Calendar with availability [#40]
+
 ## [0.20.0]
 
  * Change invalid request message to include errors [#36]
@@ -53,6 +57,7 @@
 [0.18.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.18.0
 [0.19.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.19.0
 [0.20.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.20.0
+[0.21.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.20.0
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -68,3 +73,4 @@
 [#36]: https://github.com/cronofy/cronofy-ruby/pull/36
 [#37]: https://github.com/cronofy/cronofy-ruby/pull/37
 [#38]: https://github.com/cronofy/cronofy-ruby/pull/38
+[#40]: https://github.com/cronofy/cronofy-ruby/pull/40

data/lib/cronofy/client.rb

@@ -711,58 +711,67 @@ module Cronofy
     # Public: Generates an add to calendar link to start the OAuth process with
     # an event to be automatically upserted
     #
-    # oauth       - A Hash describing the OAuth flow required:
-    #               :scope        - A String representing the scopes to ask for
-    #                               within the OAuth flow
-    #               :redirect_uri - A String containing a url to redirect the
-    #                               user to after completing the OAuth flow.
-    #               :scope        - A String representing additional state to
-    #                               be passed within the OAuth flow.
-    #
-    # event       - A Hash describing the event with symbolized keys:
-    #               :event_id     - A String uniquely identifying the event for
-    #                               your application (note: this is NOT an ID
-    #                               generated by Cronofy).
-    #               :summary      - A String to use as the summary, sometimes
-    #                               referred to as the name or title, of the
-    #                               event.
-    #               :description  - A String to use as the description, sometimes
-    #                               referred to as the notes or body, of the
-    #                               event.
-    #               :start        - The Time or Date the event starts.
-    #               :end          - The Time or Date the event ends.
-    #               :url          - The URL associated with the event.
-    #               :location     - A Hash describing the location of the event
-    #                               with symbolized keys (optional):
-    #                               :description - A String describing the
-    #                                              location.
-    #                               :lat - A String of the location's latitude.
-    #                               :long - A String of the location's longitude.
-    #               :reminders    - An Array of Hashes describing the desired
-    #                               reminders for the event. Reminders should be
-    #                               specified in priority order as, for example,
-    #                               when the underlying provider only supports a
-    #                               single reminder then the first reminder will
-    #                               be used.
-    #                               :minutes - An Integer specifying the number
-    #                                          of minutes before the start of the
-    #                                          event that the reminder should
-    #                                          occur.
-    #               :transparency - The transparency state for the event (optional).
-    #                               Accepted values are "transparent" and "opaque".
-    #               :attendees    - A Hash of :invite and :reject, each of which is
-    #                               an array of invitees to invite to or reject from
-    #                               the event. Invitees are represented by a hash of
-    #                               :email and :display_name (optional).
+    # oauth            - A Hash describing the OAuth flow required:
+    #                    :scope             - A String representing the scopes to ask for
+    #                                         within the OAuth flow
+    #                    :redirect_uri      - A String containing a url to redirect the
+    #                                         user to after completing the OAuth flow.
+    #                    :scope             - A String representing additional state to
+    #                                         be passed within the OAuth flow.
+    #
+    # event            - A Hash describing the event with symbolized keys:
+    #                    :event_id          - A String uniquely identifying the event for
+    #                                         your application (note: this is NOT an ID
+    #                                         generated by Cronofy).
+    #                    :summary           - A String to use as the summary, sometimes
+    #                                         referred to as the name or title, of the
+    #                                         event.
+    #                    :description       - A String to use as the description, sometimes
+    #                                         referred to as the notes or body, of the
+    #                                         event.
+    #                    :start             - The Time or Date the event starts.
+    #                    :end               - The Time or Date the event ends.
+    #                    :url               - The URL associated with the event.
+    #                    :location          - A Hash describing the location of the event
+    #                                         with symbolized keys (optional):
+    #                                         :description - A String describing the
+    #                                                        location.
+    #                                         :lat - A String of the location's latitude.
+    #                                         :long - A String of the location's longitude.
+    #                    :reminders         - An Array of Hashes describing the desired
+    #                                         reminders for the event. Reminders should be
+    #                                         specified in priority order as, for example,
+    #                                         when the underlying provider only supports a
+    #                                         single reminder then the first reminder will
+    #                                         be used.
+    #                                         :minutes - An Integer specifying the number
+    #                                                    of minutes before the start of the
+    #                                                    event that the reminder should
+    #                                                    occur.
+    #                    :transparency      - The transparency state for the event (optional).
+    #                                         Accepted values are "transparent" and "opaque".
+    #                    :attendees         - A Hash of :invite and :reject, each of which is
+    #                                         an array of invitees to invite to or reject from
+    #                                         the event. Invitees are represented by a hash of
+    #                                         :email and :display_name (optional).
+    # availability     - A Hash describing the availability details for the event:
+    #                    :participants      - A hash stating who is required for the availability
+    #                                         call
+    #                    :required_duration - A hash stating the length of time the event will
+    #                                         last for
+    #                    :available_periods - A hash stating the available periods for the event
+    # target_calendars - An array of hashes stating into which calendars to insert the created
+    #                    event
     #
     # Examples
     #
+    # - OAuth example
     #   client.add_to_calendar(
     #    oauth: {
     #      scopes: 'read_events delete_events',
     #      redirect_uri: 'http://www.example.com',
     #      state: 'example_state'
-    #    }
+    #    },
     #    event: {
     #     event_id: "qTtZdczOccgaPncGJaCiLg",
     #     summary: "Board meeting",
@@ -775,6 +784,43 @@ module Cronofy
     #       long: "0.1234"
     #     })
     #
+    # - Availability example
+    #   client.add_to_calendar(
+    #    oauth: {
+    #     redirect_uri: 'http://www.example.com'
+    #    },
+    #    event: {
+    #     event_id: "qTtZdczOccgaPncGJaCiLg",
+    #     summary: "Board meeting",
+    #     description: "Discuss plans for the next quarter.",
+    #     location: {
+    #       description: "Board room",
+    #       lat: "1.2345",
+    #       long: "0.1234"
+    #     }
+    #    },
+    #    availability: {
+    #      participants: [
+    #       {
+    #         members: [{
+    #           sub: "acc_567236000909002",
+    #           calendar_ids: ["cal_n23kjnwrw2_jsdfjksn234"]
+    #         }],
+    #         required: 'all'
+    #       }
+    #     ],
+    #     required_duration: { minutes: 60 },
+    #     available_periods: [{
+    #       start: Time.utc(2017, 1, 1, 9, 00),
+    #       end:   Time.utc(2017, 1, 1, 17, 00),
+    #     }]
+    #    },
+    #    target_calendars: [{
+    #     sub: "acc_567236000909002",
+    #     calendar_id: "cal_n23kjnwrw2_jsdfjksn234"
+    #    }]
+    #   )
+    #
     # See http://www.cronofy.com/developers/api#upsert-event for reference.
     #
     # Returns a AddToCalendarResponse.
@@ -790,12 +836,15 @@ module Cronofy
     # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
     # limits for the application.
     def add_to_calendar(args = {})
-      body = {
-        client_id: @client_id,
-        client_secret: @client_secret,
-        oauth: args[:oauth],
-        event: args[:event],
-      }
+      body = args.merge(client_id: @client_id, client_secret: @client_secret)
+
+      if availability = body[:availability]
+        availability[:participants] = map_availability_participants(availability[:participants])
+        availability[:required_duration] = map_availability_required_duration(availability[:required_duration])
+
+        translate_available_periods(availability[:available_periods])
+        body[:availability] = availability
+      end
 
       body[:event][:start] = encode_event_time(body[:event][:start]) if body[:event][:start]
       body[:event][:end] = encode_event_time(body[:event][:end]) if body[:event][:end]

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.20.0".freeze
+  VERSION = "0.21.0".freeze
 end

data/spec/lib/cronofy/client_spec.rb

@@ -1437,9 +1437,19 @@ describe Cronofy::Client do
       {
         oauth: oauth_body,
         event: event,
+        target_calendars: target_calendars,
       }
     end
 
+    let(:target_calendars) do
+      [
+        {
+          sub: "acc_567236000909002",
+          calendar_id: "cal_n23kjnwrw2_jsdfjksn234",
+        }
+      ]
+    end
+
     let(:request_body) do
       {
         client_id: client_id,
@@ -1459,7 +1469,151 @@ describe Cronofy::Client do
             { :minutes => 0 },
             { :minutes => 10 },
           ],
+        },
+        target_calendars: target_calendars,
+      }
+    end
+    let(:correct_response_code) { 202 }
+    let(:correct_response_body) do
+      {
+        oauth_url: "http://www.example.com/oauth?token=example"
+      }
+    end
+
+    subject { client.add_to_calendar(args) }
+
+    context 'when start/end are Times' do
+      it_behaves_like 'a Cronofy request'
+    end
+
+  end
+
+  describe "Add to calendar availability" do
+    let(:request_url) { "https://api.cronofy.com/v1/add_to_calendar" }
+    let(:url) { URI("https://example.com") }
+    let(:method) { :post }
+    let(:request_headers) { json_request_headers }
+
+    let(:start_datetime) { Time.utc(2014, 8, 5, 15, 30, 0) }
+    let(:end_datetime) { Time.utc(2014, 8, 5, 17, 0, 0) }
+    let(:encoded_start_datetime) { "2014-08-05T15:30:00Z" }
+    let(:encoded_end_datetime) { "2014-08-05T17:00:00Z" }
+    let(:location) { { :description => "Board room" } }
+    let(:transparency) { nil }
+    let(:client_id) { 'example_id' }
+    let(:client_secret) { 'example_secret' }
+    let(:scope) { 'read_events delete_events' }
+    let(:state) { 'example_state' }
+    let(:redirect_uri) { 'http://example.com/redirect' }
+
+    let(:client) do
+      Cronofy::Client.new(
+        client_id: client_id,
+        client_secret: client_secret,
+        access_token: token,
+      )
+    end
+
+    let(:event) do
+      {
+        :event_id => "qTtZdczOccgaPncGJaCiLg",
+        :summary => "Board meeting",
+        :description => "Discuss plans for the next quarter.",
+        :url => url,
+        :location => location,
+        :transparency => transparency,
+        :reminders => [
+          { :minutes => 60 },
+          { :minutes => 0 },
+          { :minutes => 10 },
+        ],
+      }
+    end
+
+    let(:oauth_body) do
+      {
+        scope: scope,
+        redirect_uri: redirect_uri,
+        state: state,
+      }
+    end
+
+    let(:target_calendars) do
+      [
+        {
+          sub: "acc_567236000909002",
+          calendar_id: "cal_n23kjnwrw2_jsdfjksn234",
         }
+      ]
+    end
+
+    let(:availability) do
+      {
+        participants: [
+          {
+            members: [{
+              sub: "acc_567236000909002",
+              calendar_ids: ["cal_n23kjnwrw2_jsdfjksn234"]
+            }],
+            required: 'all'
+          }
+        ],
+        required_duration: { minutes: 60 },
+        available_periods: [{
+          start: Time.utc(2017, 1, 1, 9, 00),
+          end:   Time.utc(2017, 1, 1, 17, 00),
+        }]
+      }
+    end
+
+    let(:mapped_availability) do
+      {
+        participants: [
+          {
+            members: [{
+              sub: "acc_567236000909002",
+              calendar_ids: ["cal_n23kjnwrw2_jsdfjksn234"]
+            }],
+            required: 'all'
+          }
+        ],
+        required_duration: { minutes: 60 },
+        available_periods: [{
+          start: "2017-01-01T09:00:00Z",
+          end:   "2017-01-01T17:00:00Z",
+        }]
+      }
+    end
+
+    let(:args) do
+      {
+        oauth: oauth_body,
+        event: event,
+        target_calendars: target_calendars,
+        availability: availability,
+      }
+    end
+
+    let(:request_body) do
+      {
+        client_id: client_id,
+        client_secret: client_secret,
+        oauth: oauth_body,
+        event: {
+          :event_id => "qTtZdczOccgaPncGJaCiLg",
+          :summary => "Board meeting",
+          :description => "Discuss plans for the next quarter.",
+          :url => url.to_s,
+          :location => location,
+          :transparency => transparency,
+          :reminders => [
+            { :minutes => 60 },
+            { :minutes => 0 },
+            { :minutes => 10 },
+          ],
+        },
+        target_calendars: target_calendars,
+        availability: mapped_availability,
       }
     end
     let(:correct_response_code) { 202 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-13 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Cronofy - one API for all the calendars