cronofy 0.35.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c20768b0500ee2cb9e902443eada181d2cddafad064febfe1d9e89481fc3d242
-  data.tar.gz: 822d3f453e190ef16b42a07a24ceeba06375bc8641d544cf09085d79f6fce101
+  metadata.gz: e085c07872654ff1e239fcdce81beeb212856ce2ff7d9c3168e71c3f2778e6d5
+  data.tar.gz: 0ce2421b8e0aa2b39c76a72eaeeddd4a474573690a6d3ccdf437c1d57dbf0028
 SHA512:
-  metadata.gz: 4992da5ff0a8becd7237982e8867b67b8f32e56d5293c3758b05494b38f05307b841e9109f1299cd968e4d0b1f9f6d16da463553d8167d6bc8113c613440f122
-  data.tar.gz: 505d13d30dfced6e3c7524ceecd7efcaa51bbede71761f948a3583c91d4c35e65d3481d8851da78a03ed28ad870307bbc30ec6f18a8b0a5904926204aae17f62
+  metadata.gz: 8df4506dfe09d4454c8901e312dbda5d03a27d1ec8a0cb28506327f8802a691fa5abf00abd8028ee6f04d9c09eae73f3a0ea417409e7164b2fa1e0e4530bb2a3
+  data.tar.gz: fe07ce98f72073fa8c0254510a089fbf04d37d5da2a12b7c12d1de77e19e1666c394d14aca6d32d96ad2ee7093b1e276ad5571f0ffcfd615a4d269e70031e07b

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.36.0]
+
+ * Add support for Available Periods [#81]
+
 ## [0.35.0]
 
  * Add specific errors for network issues [#77]
@@ -162,6 +166,7 @@
 [0.33.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.33.0
 [0.34.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.34.0
 [0.35.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.35.0
+[0.36.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.36.0
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -201,3 +206,4 @@
 [#74]: https://github.com/cronofy/cronofy-ruby/pull/74
 [#75]: https://github.com/cronofy/cronofy-ruby/pull/75
 [#77]: https://github.com/cronofy/cronofy-ruby/pull/77
+[#81]: https://github.com/cronofy/cronofy-ruby/pull/81

data/cronofy.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", ">=  1.6", "< 3"
   spec.add_development_dependency "rake",    "~> 10.0"
   spec.add_development_dependency "rspec",   "~>  3.2"
-  spec.add_development_dependency "webmock", "~>  1.21"
+  spec.add_development_dependency "webmock", "~>  3.9.1"
 end

data/lib/cronofy/client.rb

@@ -1,3 +1,5 @@
+require 'uri'
+
 module Cronofy
   # Public: Primary class for interacting with the Cronofy API.
   class Client
@@ -1492,6 +1494,84 @@ module Cronofy
       nil
     end
 
+    # Public: Creates or updates an AvailablePeriod.
+    #
+    # available_period_id - A String uniquely identifying the available period
+    #                       for the authenticated user in your application
+    #                       (note: this is NOT an ID generated by Cronofy).
+    # body                - A Hash describing the available period with
+    #                       symbolized keys:
+    #                       :start - A String (ISO-8601 date/time)
+    #                       :end   - A String (ISO-8601 date/time)
+    #
+    # See https://docs.cronofy.com/developers/api/scheduling/available-periods/upsert/
+    # for reference.
+    #
+    # 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 upsert_available_period(available_period_id, body)
+      payload = body.merge(available_period_id: available_period_id)
+      wrapped_request { post("/v1/available_periods", payload) }
+      nil
+    end
+
+    # Public: Gets all AvailablePeriods for an account.
+    #
+    # options - The Hash options used to refine the selection (default: {}):
+    #           :from            - The minimum Date from which to return periods
+    #                              (optional).
+    #           :to              - The Date to return periods up until (optional).
+    #           :tzid            - A String representing a known time zone
+    #                              identifier from the IANA Time Zone Database
+    #                              (default: Etc/UTC).
+    #           :localized_times - A Boolean specifying whether the start and
+    #                              end times should be returned with any
+    #                              available localization information
+    #                              (optional).
+    #
+    # Returns an array of AvailablePeriods.
+    #
+    # 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_available_periods(options={})
+      query = {}
+      query[:from] = to_iso8601(options[:from]) if options[:from]
+      query[:to] = to_iso8601(options[:to]) if options[:to]
+      query[:tzid] = options[:tzid] if options[:tzid]
+      query[:localized_times] = options[:localized_times] if options[:localized_times]
+      if query.any?
+        query_string = "?#{URI.encode_www_form(query)}"
+      end
+
+      response = wrapped_request { get("/v1/available_periods#{query_string}") }
+      parse_collection(AvailablePeriod, 'available_periods', response)
+    end
+
+    # Public: Deletes an AvailablePeriod.
+    #
+    # available_period_id - A String uniquely identifying the available period
+    #                      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_available_period(available_period_id)
+      wrapped_request { delete("/v1/available_periods", available_period_id: available_period_id) }
+      nil
+    end
+
     # Public: Creates a scheduling conversation
     #
     # pre release end-point documentation to follow

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.35.0".freeze
+  VERSION = "0.36.0".freeze
 end

data/spec/lib/cronofy/client_spec.rb

@@ -3152,4 +3152,160 @@ describe Cronofy::Client do
 
     it_behaves_like 'a Cronofy request'
   end
+
+  describe "#upsert_available_period" do
+    let(:request_url) { 'https://api.cronofy.com/v1/available_periods' }
+    let(:method) { :post }
+    let(:available_period_id) { "test" }
+    let(:request_body) do
+      {
+        available_period_id: available_period_id,
+        start: "2020-07-26T15:30:00Z",
+        end: "2020-07-26T17:00:00Z"
+      }
+    end
+
+    let(:correct_response_code) { 202 }
+    let(:correct_response_body) { "" }
+    let(:correct_mapped_result) { nil }
+
+    subject {
+      client.upsert_available_period(available_period_id,
+        start: request_body[:start],
+        end: request_body[:end]
+      )
+    }
+
+    it_behaves_like 'a Cronofy request'
+    it_behaves_like 'a Cronofy request with mapped return value'
+  end
+
+  describe "#get_available_periods" do
+    context "unfiltered" do
+      let(:request_url) { "https://api.cronofy.com/v1/available_periods" }
+      let(:method) { :get }
+
+      let(:correct_response_code) { 200 }
+      let(:correct_response_body) do
+        {
+          "available_periods" => [
+            {
+              "available_period_id" => "qTtZdczOccgaPncGJaCiLg",
+              "start" => "2020-07-26T15:30:00Z",
+              "end" => "2020-07-26T17:00:00Z"
+            }
+          ]
+        }
+      end
+
+      let(:correct_mapped_result) do
+        period = correct_response_body['available_periods'][0]
+
+        [
+          Cronofy::AvailablePeriod.new(
+            available_period_id: period['available_period_id'],
+            start: period['start'],
+            end: period['end']
+          )
+        ]
+      end
+
+      subject { client.get_available_periods }
+
+      it_behaves_like 'a Cronofy request'
+      it_behaves_like 'a Cronofy request with mapped return value'
+    end
+
+    context "filterd by date range" do
+      let(:tzid) { "America/New_York" }
+      let(:from) { "2020-07-01" }
+      let(:to) { "2020-07-31" }
+      let(:request_url) { "https://api.cronofy.com/v1/available_periods?from=#{from}&to=#{to}&tzid=#{tzid}" }
+      let(:method) { :get }
+
+      let(:correct_response_code) { 200 }
+      let(:correct_response_body) do
+        {
+          "available_periods" => [
+            {
+              "available_period_id" => "qTtZdczOccgaPncGJaCiLg",
+              "start" => "2020-07-26T15:30:00Z",
+              "end" => "2020-07-26T17:00:00Z"
+            }
+          ]
+        }
+      end
+
+      let(:correct_mapped_result) do
+        period = correct_response_body['available_periods'][0]
+
+        [
+          Cronofy::AvailablePeriod.new(
+            available_period_id: period['available_period_id'],
+            start: period['start'],
+            end: period['end']
+          )
+        ]
+      end
+
+      subject { client.get_available_periods(from: from, to: to, tzid: tzid) }
+
+      it_behaves_like 'a Cronofy request'
+      it_behaves_like 'a Cronofy request with mapped return value'
+    end
+
+    context "requesting localized times" do
+      let(:tzid) { "America/New_York" }
+      let(:localized_times) { true }
+      let(:request_url) { "https://api.cronofy.com/v1/available_periods?tzid=#{tzid}&localized_times=true" }
+      let(:method) { :get }
+
+      let(:correct_response_code) { 200 }
+      let(:correct_response_body) do
+        {
+          "available_periods" => [
+            {
+              "available_period_id" => "qTtZdczOccgaPncGJaCiLg",
+              "start" => "2020-07-26T15:30:00Z",
+              "end" => "2020-07-26T17:00:00Z"
+            }
+          ]
+        }
+      end
+
+      let(:correct_mapped_result) do
+        period = correct_response_body['available_periods'][0]
+
+        [
+          Cronofy::AvailablePeriod.new(
+            available_period_id: period['available_period_id'],
+            start: period['start'],
+            end: period['end']
+          )
+        ]
+      end
+
+      subject { client.get_available_periods(tzid: tzid, localized_times: true) }
+
+      it_behaves_like 'a Cronofy request'
+      it_behaves_like 'a Cronofy request with mapped return value'
+    end
+  end
+
+  describe '#delete_available_period' do
+    let(:available_period_id) { 'default'}
+    let(:request_url) { "https://api.cronofy.com/v1/available_periods" }
+    let(:method) { :delete }
+    let(:request_body) {
+      { available_period_id: available_period_id}
+    }
+    let(:correct_response_code) { 202 }
+    let(:correct_response_body) { "" }
+    let(:correct_mapped_result) { nil }
+
+    subject { client.delete_available_period(available_period_id) }
+
+    it_behaves_like 'a Cronofy request'
+    it_behaves_like 'a Cronofy request with mapped return value'
+  end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 0.36.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
 - Garry Shutler
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2020-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -99,14 +99,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: 3.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: 3.9.1
 description: Ruby wrapper for Cronofy's unified calendar API
 email:
 - parizhskiy@gmail.com
@@ -141,7 +141,7 @@ homepage: https://github.com/cronofy/cronofy-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,8 +156,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Cronofy - one API for all the calendars
 test_files: