cronofy 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf2e08298ccea5ded0fbfdda981849d4baa3afe0
-  data.tar.gz: 7e790d91714ec2aa9b426ae16e0348d7854878c6
+  metadata.gz: 4f999ccb12faff1b50ff5f6069670c5edaeecdba
+  data.tar.gz: a5eb234959601811c9518e60ee7f614b4e9a658c
 SHA512:
-  metadata.gz: 1f90a02ae698495b2d3a6b904172a9cb69526a7fb729a45e3e4bf6de965dcc0de7d11d5ff1bc96d28ebe9a88b4087eee36041c4c1d6dc71c44ef291f8e660462
-  data.tar.gz: 9b80e6db0d04ab9687dc09dde40a5bf0ae1c076c837b3674ed19cc3e43abe41cdc3db2ce0c58eb080556e727ccc916e23d09afc40681bd1190e6897fd1917909
+  metadata.gz: 3317567d3489c8d7621f99e3deb35a40dd08854ff19d14a5919bb89a6d21d59fc2a55f14e602f3bb1d39c7f1d8d559d9044708f4bf475f7bf1c69687f9422386
+  data.tar.gz: ef28b30f3a07e251ba34a785e87e849cb0b3deae030438a2ecaac9d4a1d3091b4187c5077c94ae22df40de47fb22e5021e1da4cf24caa4bbec15d7620256f74e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.19.0]
+
+ * Support add to calendar #31]
+
 ## [0.18.0]
 
  * Support multiple data centres [#30]
@@ -40,6 +44,7 @@
 [0.16.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.16.0
 [0.17.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.17.0
 [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
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -50,3 +55,4 @@
 [#26]: https://github.com/cronofy/cronofy-ruby/pull/26
 [#27]: https://github.com/cronofy/cronofy-ruby/pull/27
 [#30]: https://github.com/cronofy/cronofy-ruby/pull/30
+[#31]: https://github.com/cronofy/cronofy-ruby/pull/31

data/lib/cronofy/client.rb

@@ -27,15 +27,15 @@ module Cronofy
     #                            centre (optional).
     def initialize(options = {})
       access_token  = options[:access_token]
-      client_id     = options.fetch(:client_id, ENV["CRONOFY_CLIENT_ID"])
-      client_secret = options.fetch(:client_secret, ENV["CRONOFY_CLIENT_SECRET"])
       refresh_token = options[:refresh_token]
 
+      @client_id     = options.fetch(:client_id, ENV["CRONOFY_CLIENT_ID"])
+      @client_secret = options.fetch(:client_secret, ENV["CRONOFY_CLIENT_SECRET"])
       @data_centre   = options[:data_centre]
 
       @auth = Auth.new(
-        client_id: client_id,
-        client_secret: client_secret,
+        client_id: @client_id,
+        client_secret: @client_secret,
         access_token: access_token,
         refresh_token: refresh_token,
         data_centre: @data_centre,
@@ -90,34 +90,40 @@ module Cronofy
     # calendar_id - The String Cronofy ID for the calendar to upsert the event
     #               to.
     # 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.
+    #               :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).
     #
     # Examples
     #
@@ -193,6 +199,9 @@ module Cronofy
     #                              after in order to be returned (optional).
     #           :calendar_ids    - An Array of calendar ids for restricting the
     #                              returned events (optional).
+    #           :include_geo     - A Boolean specifying whether the events should
+    #                              have their location.lat and location.long
+    #                              returned where available (optional).
     #
     # The first page will be retrieved eagerly so that common errors will happen
     # inline. However, subsequent pages (if any) will be requested lazily.
@@ -690,6 +699,103 @@ module Cronofy
       parse_collection(AvailablePeriod, "available_periods", response)
     end
 
+
+    # 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).
+    #
+    # Examples
+    #
+    #   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",
+    #     description: "Discuss plans for the next quarter.",
+    #     start: Time.utc(2014, 8, 5, 15, 30),
+    #     end:   Time.utc(2014, 8, 5, 17, 30),
+    #     location: {
+    #       description: "Board room",
+    #       lat: "1.2345",
+    #       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 = {
+        client_id: @client_id,
+        client_secret: @client_secret,
+        oauth: args[:oauth],
+        event: args[:event],
+      }
+
+      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]
+
+      response = post("/v1/add_to_calendar", body)
+      parse_json(AddToCalendarResponse, nil , response)
+    end
+
     private
 
     def translate_available_periods(periods)

data/lib/cronofy/types.rb

@@ -282,6 +282,9 @@ module Cronofy
   class Participant < Hashie::Mash
   end
 
+  class AddToCalendarResponse < Hashie::Mash
+  end
+
   module ParticipantEnumerable
     def self.coerce(values)
       values.map { |v| Participant.new(v) }

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.18.0".freeze
+  VERSION = "0.19.0".freeze
 end

data/spec/lib/cronofy/client_spec.rb

@@ -225,6 +225,7 @@ describe Cronofy::Client do
       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(:event) do
         {
@@ -235,6 +236,7 @@ describe Cronofy::Client do
           :end => end_datetime,
           :url => url,
           :location => location,
+          :transparency => transparency,
           :reminders => [
             { :minutes => 60 },
             { :minutes => 0 },
@@ -251,6 +253,7 @@ describe Cronofy::Client do
           :end => encoded_end_datetime,
           :url => url.to_s,
           :location => location,
+          :transparency => transparency,
           :reminders => [
             { :minutes => 60 },
             { :minutes => 0 },
@@ -310,6 +313,12 @@ describe Cronofy::Client do
 
         it_behaves_like 'a Cronofy request'
       end
+
+      context 'when transparency present' do
+        let(:transparency) { "transparent" }
+
+        it_behaves_like 'a Cronofy request'
+      end
     end
 
     describe '#read_events' do
@@ -1264,6 +1273,71 @@ describe Cronofy::Client do
         it_behaves_like 'a Cronofy request with mapped return value'
       end
 
+      context "member-specific calendars" do
+        let(:request_body) do
+          {
+            "participants" => [
+              {
+                "members" => [
+                  { "sub" => "acc_567236000909002" },
+                  {
+                    "sub" => "acc_678347111010113",
+                    "calendar_ids" => [
+                      "cal_1234_5678",
+                      "cal_9876_5432",
+                    ]
+                  }
+                ],
+                "required" => "all"
+              }
+            ],
+            "required_duration" => { "minutes" => 60 },
+            "available_periods" => [
+              {
+                "start" => "2017-01-03T09:00:00Z",
+                "end" => "2017-01-03T18:00:00Z"
+              },
+              {
+                "start" => "2017-01-04T09:00:00Z",
+                "end" => "2017-01-04T18:00:00Z"
+              }
+            ]
+          }
+        end
+
+        let(:participants) do
+          [
+            {
+              members: [
+                { sub: "acc_567236000909002" },
+                {
+                  sub: "acc_678347111010113",
+                  calendar_ids: [
+                    "cal_1234_5678",
+                    "cal_9876_5432",
+                  ],
+                },
+              ],
+              required: :all,
+            }
+          ]
+        end
+
+        let(:required_duration) do
+          { minutes: 60 }
+        end
+
+        let(:available_periods) do
+          [
+            { start: Time.parse("2017-01-03T09:00:00Z"), end: Time.parse("2017-01-03T18:00:00Z") },
+            { start: Time.parse("2017-01-04T09:00:00Z"), end: Time.parse("2017-01-04T18:00:00Z") },
+          ]
+        end
+
+        it_behaves_like 'a Cronofy request'
+        it_behaves_like 'a Cronofy request with mapped return value'
+      end
+
       context "simple values to defaults" do
         let(:participants) do
           { members: %w{acc_567236000909002 acc_678347111010113} }
@@ -1284,6 +1358,102 @@ describe Cronofy::Client do
     end
   end
 
+  describe "Add to calendar" 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.",
+        :start => start_datetime,
+        :end => end_datetime,
+        :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(:args) do
+      {
+        oauth: oauth_body,
+        event: event,
+      }
+    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.",
+          :start => encoded_start_datetime,
+          :end => encoded_end_datetime,
+          :url => url.to_s,
+          :location => location,
+          :transparency => transparency,
+          :reminders => [
+            { :minutes => 60 },
+            { :minutes => 0 },
+            { :minutes => 10 },
+          ],
+        }
+      }
+    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 "Specified data centre" do
     let(:data_centre) { :de }
 

metadata

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