cronofy 0.25.1 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa2dbaa1fff22d1bf386ea8510b33592ae43307b
-  data.tar.gz: 98f437522497ffa946e62e1d860d9ddbbbcd5726
+  metadata.gz: 62d037f0b84f5f60661b7875c8bf2645df8a5b94
+  data.tar.gz: fbbb34833ed05e6ad74375dff707a73ae0138458
 SHA512:
-  metadata.gz: 8526a9632f28225092530b0250af075529bca6607260897f9b599438d846cf4c624c5d86d42a4ae59359d71e7e2047101a1aff0b6b6ddb5e02f7b2f74b9e4a53
-  data.tar.gz: dd3774efc5c33c90001829391c7bf8a30c3636a4308485e5ffa3ca5e9ddfea2a2b224177c318cf7eef1a6b6b5af120aba8cebab79c1475e1165b0a05a6b0b801
+  metadata.gz: 923d240d65bb915cd34560f41c0752ec39e3bed611b000c5fea4c9648afe31eccce96b5e19a16a9b5e28b9b3b135a56b621df916c7c8100fc00cbe2e6d12869d
+  data.tar.gz: 4d5bfa47913f8439892f10c458dec0464701ccaeb3f0561e2d6bf01c9b479ce7b01d5411464f06a9d02583163d5b31e23f31e186384773c223d9046998c99f12

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.26.0]
+
+ * Support for batch endpoint [#53]
+
 ## [0.25.1]
 
  * Support for Cancelling Smart Invites [#55]
@@ -91,6 +95,7 @@
 [0.24.1]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.24.1
 [0.25.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.25.0
 [0.25.1]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.25.1
+[0.26.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.26.0
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -115,4 +120,5 @@
 [#49]: https://github.com/cronofy/cronofy-ruby/pull/49
 [#50]: https://github.com/cronofy/cronofy-ruby/pull/50
 [#52]: https://github.com/cronofy/cronofy-ruby/pull/52
+[#53]: https://github.com/cronofy/cronofy-ruby/pull/53
 [#55]: https://github.com/cronofy/cronofy-ruby/pull/55

data/lib/cronofy.rb

@@ -3,6 +3,7 @@ require "cronofy/errors"
 require "cronofy/types"
 require "cronofy/api_key"
 require "cronofy/auth"
+require "cronofy/time_encoding"
 require "cronofy/client"
 require "cronofy/response_parser"
 

data/lib/cronofy/client.rb

@@ -1,6 +1,8 @@
 module Cronofy
   # Public: Primary class for interacting with the Cronofy API.
   class Client
+    include TimeEncoding
+
     # Public: The scope to request if none is explicitly specified by the
     # caller.
     DEFAULT_OAUTH_SCOPE = %w{
@@ -308,6 +310,75 @@ module Cronofy
       nil
     end
 
+    class BatchBuilder
+      include TimeEncoding
+
+      def initialize
+        @entries = []
+      end
+
+      def upsert_event(calendar_id, event)
+        data = event.dup
+
+        data[:start] = encode_event_time(data[:start])
+        data[:end] = encode_event_time(data[:end])
+
+        post "/v1/calendars/#{calendar_id}/events", data
+      end
+
+      alias_method :create_or_update_event, :upsert_event
+
+      def delete_event(calendar_id, event_id)
+        delete "/v1/calendars/#{calendar_id}/events", event_id: event_id
+      end
+
+      def delete_external_event(calendar_id, event_uid)
+        delete "/v1/calendars/#{calendar_id}/events", event_uid: event_uid
+      end
+
+      def add_entry(args)
+        @entries << BatchEntryRequest.new(args)
+        nil
+      end
+
+      def build
+        @entries.dup
+      end
+
+      private
+
+      def delete(relative_url, data)
+        add_entry(method: "DELETE", relative_url: relative_url, data: data)
+      end
+
+      def post(relative_url, data)
+        add_entry(method: "POST", relative_url: relative_url, data: data)
+      end
+    end
+
+    def batch
+      yield builder = BatchBuilder.new
+
+      requests = builder.build
+
+      response = post("/v1/batch", batch: requests)
+      responses = parse_collection(BatchEntryResponse, "batch", response)
+
+      entries = requests.zip(responses).map do |request, response|
+        response.request = request
+        response
+      end
+
+      result = BatchResponse.new(entries)
+
+      if result.errors?
+        msg = "Batch contains #{result.errors.count} errors"
+        raise BatchResponse::PartialSuccessError.new(msg, result)
+      end
+
+      result
+    end
+
     # Public: Deletes an external event from the specified calendar
     #
     # calendar_id - The String Cronofy ID for the calendar to delete the event
@@ -1231,35 +1302,6 @@ module Cronofy
       end
     end
 
-    def to_iso8601(value)
-      case value
-      when NilClass
-        nil
-      when Time
-        value.getutc.iso8601
-      else
-        value.iso8601
-      end
-    end
-
-    def encode_event_time(time)
-      result = time
-
-      case time
-      when String
-        time
-      when Hash
-        if time[:time]
-          encoded_time = encode_event_time(time[:time])
-          time.merge(time: encoded_time)
-        else
-          time
-        end
-      else
-        to_iso8601(time)
-      end
-    end
-
     class PagedResultIterator
       include Enumerable
 

data/lib/cronofy/time_encoding.rb

@@ -0,0 +1,31 @@
+module Cronofy
+  module TimeEncoding
+    def encode_event_time(value)
+      case value
+      when String
+        value
+      when Hash
+        if value[:time]
+          encoded_time = encode_event_time(value[:time])
+          value.merge(time: encoded_time)
+        else
+          value
+        end
+      else
+        to_iso8601(value)
+      end
+    end
+
+    def to_iso8601(value)
+      case value
+      when NilClass
+        nil
+      when Time
+        value.getutc.iso8601
+      else
+        value.iso8601
+      end
+    end
+
+  end
+end

data/lib/cronofy/types.rb

@@ -193,6 +193,39 @@ module Cronofy
   class Account < CronofyMash
   end
 
+  BatchEntry = Struct.new(:request, :response)
+
+  class BatchEntryRequest < CronofyMash
+  end
+
+  class BatchEntryResponse < CronofyMash
+  end
+
+  class BatchResponse
+    class PartialSuccessError < CronofyError
+      attr_reader :batch_response
+
+      def initialize(message, batch_response)
+        super(message)
+        @batch_response = batch_response
+      end
+    end
+
+    attr_reader :entries
+
+    def initialize(entries)
+      @entries = entries
+    end
+
+    def errors
+      entries.select { |entry| (entry.status % 100) != 2 }
+    end
+
+    def errors?
+      errors.any?
+    end
+  end
+
   class UserInfo < CronofyMash
   end
 

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.25.1".freeze
+  VERSION = "0.26.0".freeze
 end

data/spec/lib/cronofy/client_spec.rb

@@ -1885,4 +1885,216 @@ describe Cronofy::Client do
     it_behaves_like 'a Cronofy request'
 
   end
+
+  describe "Batch requests" do
+    context "upserting an event" do
+      let(:calendar_id) { 'calendar_id_123'}
+      let(:request_url) { "https://api.cronofy.com/v1/batch" }
+      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(: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,
+          :reminders => [
+            { :minutes => 60 },
+            { :minutes => 0 },
+            { :minutes => 10 },
+          ],
+        }
+      end
+
+      let(:request_body) do
+        {
+          :batch => [
+            {
+              :method => "POST",
+              :relative_url => "/v1/calendars/#{calendar_id}/events",
+              :data => {
+                :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,
+                :reminders => [
+                  { :minutes => 60 },
+                  { :minutes => 0 },
+                  { :minutes => 10 },
+                ],
+              }
+            }
+          ]
+        }
+      end
+
+      let(:correct_response_code) { 207 }
+      let(:correct_response_body) do
+        {
+          "batch" => [
+            { "status" => 202 }
+          ]
+        }
+      end
+
+      subject do
+        client.batch do |batch|
+          batch.upsert_event(calendar_id, event)
+        end
+      end
+
+      it_behaves_like "a Cronofy request"
+    end
+
+    context "deleting an event" do
+      let(:calendar_id) { 'calendar_id_123'}
+      let(:method) { :post }
+      let(:request_url) { "https://api.cronofy.com/v1/batch" }
+      let(:request_headers) { json_request_headers }
+
+      let(:event_id) { "asd1knkjsndk123123" }
+
+      let(:request_body) do
+        {
+          :batch => [
+            {
+              :method => "DELETE",
+              :relative_url => "/v1/calendars/#{calendar_id}/events",
+              :data => {
+                :event_id => event_id,
+              }
+            }
+          ]
+        }
+      end
+
+      let(:correct_response_code) { 207 }
+      let(:correct_response_body) do
+        {
+          "batch" => [
+            { "status" => 202 }
+          ]
+        }
+      end
+
+      subject do
+        client.batch do |batch|
+          batch.delete_event(calendar_id, event_id)
+        end
+      end
+
+      it_behaves_like "a Cronofy request"
+    end
+
+    context "deleting an external event" do
+      let(:calendar_id) { 'calendar_id_123'}
+      let(:method) { :post }
+      let(:request_url) { "https://api.cronofy.com/v1/batch" }
+      let(:request_headers) { json_request_headers }
+
+      let(:event_uid) { "evt_external_12345abcde" }
+
+      let(:request_body) do
+        {
+          :batch => [
+            {
+              :method => "DELETE",
+              :relative_url => "/v1/calendars/#{calendar_id}/events",
+              :data => {
+                :event_uid => event_uid,
+              }
+            }
+          ]
+        }
+      end
+
+      let(:correct_response_code) { 207 }
+      let(:correct_response_body) do
+        {
+          "batch" => [
+            { "status" => 202 }
+          ]
+        }
+      end
+
+      subject do
+        client.batch do |batch|
+          batch.delete_external_event(calendar_id, event_uid)
+        end
+      end
+
+      it_behaves_like "a Cronofy request"
+    end
+
+    context "partial success" do
+      let(:method) { :post }
+      let(:request_url) { "https://api.cronofy.com/v1/batch" }
+      let(:request_headers) { json_request_headers }
+
+      let(:request_body) do
+        {
+          :batch => [
+            {
+              :method => "DELETE",
+              :relative_url => "/v1/calendars/cal_123_abc/events",
+              :data => {
+                :event_id => "123",
+              }
+            },
+            {
+              :method => "DELETE",
+              :relative_url => "/v1/calendars/cal_123_def/events",
+              :data => {
+                :event_id => "456",
+              }
+            }
+          ]
+        }
+      end
+
+      let(:correct_response_code) { 207 }
+      let(:correct_response_body) do
+        {
+          "batch" => [
+            { "status" => 202 },
+            { "status" => 404 },
+          ]
+        }
+      end
+
+      subject do
+        client.batch do |batch|
+          batch.delete_event("cal_123_abc", "123")
+          batch.delete_event("cal_123_def", "456")
+        end
+      end
+
+      it "raises an error" do
+        stub_request(method, request_url)
+          .with(headers: request_headers,
+                body: request_body)
+          .to_return(status: correct_response_code,
+                     headers: correct_response_headers,
+                     body: correct_response_body.to_json)
+
+        expect { subject }.to raise_error(Cronofy::BatchResponse::PartialSuccessError) do |error|
+          expect(error.batch_response.errors?).to be true
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.25.1
+  version: 0.26.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-20 00:00:00.000000000 Z
+date: 2017-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -121,6 +121,7 @@ files:
 - lib/cronofy/client.rb
 - lib/cronofy/errors.rb
 - lib/cronofy/response_parser.rb
+- lib/cronofy/time_encoding.rb
 - lib/cronofy/types.rb
 - lib/cronofy/version.rb
 - spec/lib/cronofy/auth_spec.rb
@@ -150,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Cronofy - one API for all the calendars