cronofy 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fef21eafed29818348df191003678a502f85b40e
-  data.tar.gz: 006fff16ea068da743be34eb380bbd701523b341
+  metadata.gz: 12dca20c7955f97eac5e93f6f793e38a0363e0f1
+  data.tar.gz: a9017b0ee2708bb4cbb792507959658fd9f9a138
 SHA512:
-  metadata.gz: ad2e31f0eea49062cd7f8f60691ee05773ca184a774d0e958f31cd6f68eae5f207917a6a265872f632ed24407926495b1b2dd14c3d6f49a7beb425357c60a54f
-  data.tar.gz: e528c5a16588eb904c01bf01ce0890694efca321eba9e31976a8ad76a16fcc439f38236d0dcccaac6d27922dc89ad13041dd21b4676c47a58fc99b1c001a2c08
+  metadata.gz: c627b9fc733638bd60bf6248919a6fa6ccbfc27f3c0836d487ca9712867cb328b0d0dd5f80c7c1f97f001b1304646f0791cda7a632583da7132e034549b81690
+  data.tar.gz: 804e5ac5f5353050105435fda63a03bbbe2577b4e214464dd8c221782719c4c2f96530bbc45f081d38650d2e6dee6eb99510f80f961781e1e38f60461eeb5dbc

data/lib/cronofy/client.rb

@@ -649,8 +649,83 @@ module Cronofy
       parse_collection(Resource, "resources", response)
     end
 
+    # Public: Performs an availability query.
+    #
+    # options - The Hash options used to refine the selection (default: {}):
+    #           :participants      - An Array of participant groups (or required
+    #                                particpants for the simple case).
+    #           :required_duration - An Integer representing the minimum number
+    #                                of minutes of availability required.
+    #           :available_periods - An Array of available time periods Hashes,
+    #                                each must specify a start and end Time.
+    #
+    # Returns an Array of AvailablePeriods.
+    #
+    # 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::InvalidRequestError if the request contains invalid
+    # parameters.
+    # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
+    # limits for the application.
+    def availability(options = {})
+      options[:participants] = map_availability_participants(options[:participants])
+      options[:required_duration] = map_availability_required_duration(options[:required_duration])
+
+      options[:available_periods].each do |params|
+        AVAILABLE_PERIODS_TIME_PARAMS.select { |tp| params.key?(tp) }.each do |tp|
+          params[tp] = to_iso8601(params[tp])
+        end
+      end
+
+      response = post("/v1/availability", options)
+      parse_collection(AvailablePeriod, "available_periods", response)
+    end
+
     private
 
+    def map_availability_participants(participants)
+      case participants
+      when Hash
+        participants[:members].map! do |member|
+          map_availability_member(member)
+        end
+
+        unless participants.key?(:required)
+          participants[:required] = :all
+        end
+
+        [participants]
+      else
+        participants
+      end
+    end
+
+    def map_availability_member(member)
+      case member
+      when String
+        { sub: member }
+      else
+        member
+      end
+    end
+
+    def map_availability_required_duration(required_duration)
+      case required_duration
+      when Fixnum
+        { minutes: required_duration }
+      else
+        required_duration
+      end
+    end
+
+    AVAILABLE_PERIODS_TIME_PARAMS = %i{
+      start
+      end
+    }.freeze
+
     FREE_BUSY_DEFAULT_PARAMS = { tzid: "Etc/UTC" }.freeze
     FREE_BUSY_TIME_PARAMS = %i{
       from

data/lib/cronofy/types.rb

@@ -278,4 +278,22 @@ module Cronofy
 
   class PermissionsResponse < Hashie::Mash
   end
+
+  class Participant < Hashie::Mash
+  end
+
+  module ParticipantEnumerable
+    def self.coerce(values)
+      values.map { |v| Participant.new(v) }
+    end
+  end
+
+  class AvailablePeriod < Hashie::Mash
+    include Hashie::Extensions::Coercion
+
+    coerce_key :start, EventTime
+    coerce_key :end, EventTime
+
+    coerce_key :participants, ParticipantEnumerable
+  end
 end

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.15.0".freeze
+  VERSION = "0.16.0".freeze
 end

data/spec/lib/cronofy/client_spec.rb

@@ -749,14 +749,14 @@ describe Cronofy::Client do
       end
 
       let(:correct_mapped_result) do
-        Cronofy::PermissionsResponse.new(correct_response_body[:permissions_request])
+        Cronofy::PermissionsResponse.new(correct_response_body['permissions_request'])
       end
 
       describe "with uri supplied" do
         let(:correct_response_body) do
           {
-            permissions_request: {
-              url: "http://app.cronofy.com/permissions/"
+            "permissions_request" => {
+              "url" => "http://app.cronofy.com/permissions/"
             }
           }
         end
@@ -770,8 +770,8 @@ describe Cronofy::Client do
       describe "without uri supplied" do
         let(:correct_response_body) do
           {
-            permissions_request: {
-              accepted: true
+            "permissions_request" => {
+              "accepted" => true
             }
           }
         end
@@ -1072,16 +1072,16 @@ describe Cronofy::Client do
       let(:correct_response_code) { 200 }
       let(:correct_response_body) do
         {
-            'resources' => [
-                {
-                    'email' => 'board-room-london@example.com',
-                    'name' => 'Board room (London)',
-                },
-                {
-                    'email' => 'board-room-madrid@example.com',
-                    'name' => 'Board room (Madrid)',
-                }
-            ]
+          'resources' => [
+            {
+              'email' => 'board-room-london@example.com',
+              'name' => 'Board room (London)',
+            },
+            {
+              'email' => 'board-room-madrid@example.com',
+              'name' => 'Board room (Madrid)',
+            }
+          ]
         }
       end
 
@@ -1095,4 +1095,121 @@ describe Cronofy::Client do
       it_behaves_like 'a Cronofy request with mapped return value'
     end
   end
+
+  describe 'Availability', focus: true do
+    describe '#availability' do
+      let(:method) { :post }
+      let(:request_url) { 'https://api.cronofy.com/v1/availability' }
+      let(:request_headers) { json_request_headers }
+
+      let(:request_body) do
+        {
+          "participants" => [
+            {
+              "members" => [
+                { "sub" => "acc_567236000909002" },
+                { "sub" => "acc_678347111010113" }
+              ],
+              "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(:correct_response_code) { 200 }
+      let(:correct_response_body) do
+        {
+          "available_periods" => [
+            {
+              "start" => "2017-01-03T09:00:00Z",
+              "end" => "2017-01-03T11:00:00Z",
+              "participants" => [
+                { "sub" => "acc_567236000909002" },
+                { "sub" => "acc_678347111010113" }
+              ]
+            },
+            {
+              "start" => "2017-01-03T14 =>00:00Z",
+              "end" => "2017-01-03T16:00:00Z",
+              "participants" => [
+                { "sub" => "acc_567236000909002" },
+                { "sub" => "acc_678347111010113" }
+              ]
+            },
+            {
+              "start" => "2017-01-04T11:00:00Z",
+              "end" => "2017-01-04T17:00:00Z",
+              "participants" => [
+                { "sub" => "acc_567236000909002" },
+                { "sub" => "acc_678347111010113" }
+              ]
+            },
+          ]
+        }
+      end
+
+      let(:correct_mapped_result) do
+        correct_response_body['available_periods'].map { |ap| Cronofy::AvailablePeriod.new(ap) }
+      end
+
+      subject { client.availability(participants: participants, required_duration: required_duration, available_periods: available_periods) }
+
+      context "fully specified" do
+        let(:participants) do
+          [
+            {
+              members: [
+                { sub: "acc_567236000909002" },
+                { sub: "acc_678347111010113" },
+              ],
+              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} }
+        end
+
+        let(:required_duration) { 60 }
+
+        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
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2017-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Cronofy - one API for all the calendars