cronofy 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b09683a6a1a610a1f4e0790c918b85a403676e4
-  data.tar.gz: d79520d6abb9e4c51d07b0dc59eb020205c61624
+  metadata.gz: a48c75251078b9b71b6921cb317f6691a9add421
+  data.tar.gz: b616264212a442276812c5a4a8d944d34e4ba500
 SHA512:
-  metadata.gz: f1f7adbeaa413a282fd1d930984b9d52215326959ff3f62f690dade3210ac2f98af7701e3fc2a1975373b8275c0b0120cddf3f0cd653588309a9898089a3c0d4
-  data.tar.gz: ccb144468e56a76d91f1917647e8e0f405fa9493d66fb517d274d846acfaa418465ce052defba90e9d999e3a0734caa720c31e815a9f2cf2982f17db19b12317
+  metadata.gz: 18fb8765fa73771e8b19fdd58e6d349dd792cc82d9e2f8cc817341722e461b74e2d28d7133ddae470ff58cf41441d9dc6b77db118de23e7383586dfa3a44cd61
+  data.tar.gz: 39a63b0cdf4d63ce838fdbac5bb94d5f8bf6e3cf37b7102760b4f925f4adcfd12b08224dd64a8ce6c570a299074a8f1f4e4529badfb61102c94f96e8c1fcaa45

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.22.0]
+
+ * Splitting of Add to Calendar and Real time scheduling [#44]
+ * Support for explicit linking of accounts [#43]
+
 ## [0.21.0]
 
  * Support Add To Calendar with availability [#40]
@@ -57,7 +62,8 @@
 [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
+[0.21.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.21.0
+[0.22.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.22.0
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -74,3 +80,5 @@
 [#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
+[#43]: https://github.com/cronofy/cronofy-ruby/pull/43
+[#44]: https://github.com/cronofy/cronofy-ruby/pull/44

data/lib/cronofy/client.rb

@@ -754,18 +754,9 @@ module Cronofy
     #                                         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
+    # Example
     #
-    # - OAuth example
     #   client.add_to_calendar(
     #    oauth: {
     #      scopes: 'read_events delete_events',
@@ -784,6 +775,85 @@ module Cronofy
     #       long: "0.1234"
     #     })
     #
+    # See http://www.cronofy.com/developers/api#upsert-event for reference.
+    #
+    # Returns a AddToCalendarResponse.
+    #
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    # Raises Cronofy::AuthenticationFailureError if the access token is no
+    # longer valid.
+    # Raises Cronofy::AuthorizationFailureError if the access token does not
+    # include the required scope.
+    # Raises Cronofy::NotFoundError if the calendar does not exist.
+    # Raises Cronofy::InvalidRequestError if the request contains invalid
+    # parameters.
+    # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
+    # limits for the application.
+    def add_to_calendar(args = {})
+      body = args.merge(client_id: @client_id, client_secret: @client_secret)
+
+      body[:event][:start] = encode_event_time(body[:event][:start])
+      body[:event][:end] = encode_event_time(body[:event][:end])
+
+      response = post("/v1/add_to_calendar", body)
+      parse_json(AddToCalendarResponse, nil , response)
+    end
+
+    # Public: Generates an real time scheduling 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.
+    #                    :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
+    #
     # - Availability example
     #   client.add_to_calendar(
     #    oauth: {
@@ -835,24 +905,38 @@ module Cronofy
     # parameters.
     # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
     # limits for the application.
-    def add_to_calendar(args = {})
+    def real_time_scheduling(args = {})
       body = args.merge(client_id: @client_id, client_secret: @client_secret)
 
-      if availability = body[:availability]
+      if availability = args[: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]
+      translate_available_periods(availability[:available_periods])
+      body[:availability] = availability
 
-      response = post("/v1/add_to_calendar", body)
+      response = post("/v1/real_time_scheduling", body)
       parse_json(AddToCalendarResponse, nil , response)
     end
 
+    # Public: Creates a link_token to allow explicitly linking of an account
+    #
+    # See https://www.cronofy.com/developers/api/alpha/#auth-explicit-linking for
+    # reference.
+    #
+    # Returns a link token
+    #
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    # Raises Cronofy::AuthenticationFailureError if the access token is no
+    # longer valid.
+    # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
+    # limits for the application.
+    def link_token
+      response = post("/v1/link_tokens", nil)
+      parse_json(String, 'link_token', response)
+    end
+
     private
 
     def translate_available_periods(periods)

data/lib/cronofy/version.rb

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

data/spec/lib/cronofy/client_spec.rb

@@ -1128,6 +1128,28 @@ describe Cronofy::Client do
     end
   end
 
+  describe '#link_token' do
+    let(:request_url) { 'https://api.cronofy.com/v1/link_tokens' }
+    let(:method) { :post }
+    let(:request_body) { nil }
+
+    let(:correct_response_code) { 200 }
+    let(:correct_response_body) do
+      {
+        "link_token" => "abcd1234"
+      }
+    end
+
+    let(:correct_mapped_result) do
+      "abcd1234"
+    end
+
+    subject { client.link_token }
+
+    it_behaves_like 'a Cronofy request'
+    it_behaves_like 'a Cronofy request with mapped return value'
+  end
+
   describe 'Availability' do
     describe '#availability' do
       let(:method) { :post }
@@ -1488,16 +1510,12 @@ describe Cronofy::Client do
 
   end
 
-  describe "Add to calendar availability" do
-    let(:request_url) { "https://api.cronofy.com/v1/add_to_calendar" }
+  describe "Real time scheduling" do
+    let(:request_url) { "https://api.cronofy.com/v1/real_time_scheduling" }
     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' }
@@ -1623,7 +1641,7 @@ describe Cronofy::Client do
       }
     end
 
-    subject { client.add_to_calendar(args) }
+    subject { client.real_time_scheduling(args) }
 
     context 'when start/end are Times' do
       it_behaves_like 'a Cronofy request'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-21 00:00:00.000000000 Z
+date: 2017-06-09 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.4
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Cronofy - one API for all the calendars