cronofy 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3f4ad1bcd1d60b04de2d5a623899783666eace5
-  data.tar.gz: db32fd4cb307bd4c6b6d41c87dab2d7d7149091a
+  metadata.gz: 326fa8f77f51139784236c0a9e2f73cdc53edecc
+  data.tar.gz: 3b314897d498fcf530953ac9bd44bcfd7b21f533
 SHA512:
-  metadata.gz: c25bdc2ca36a4b3350e2634e63a4bbd505e52ccc3fc53b661acdd44a4c5fe3acd0d3e15ed3e236fb4e15807a71d54d8bf2d1309812d92b54edfc373a7183574f
-  data.tar.gz: b1d3651e5dad66f624c7c9d46dd95572f59f0701165bbe43af7df82c4bdf333460a1fc0be6965173f683acf5d66fd3c87692eb18d01225679f1680388a9d9e57
+  metadata.gz: b36221de26d3abf310b4be4ce4ea29a7c02bf0858ea36f9924488559fd9db24dea773b07c0a8d47863f940bb0484b4349a1b6796538c437c25b6d9dd1325591c
+  data.tar.gz: d78d17162887646dbfc909290ceabc2fb2bd080253597a54c0aa3be452504d01112dd1b1b91c323734b023bdae071b211a419a2994e0a5b7d7c60194544209c9

data/lib/cronofy/client.rb

@@ -32,6 +32,32 @@ module Cronofy
       @auth = Auth.new(client_id, client_secret, access_token, refresh_token)
     end
 
+    # Public: Creates a new calendar for the account.
+    #
+    # profile_id - The String ID of the profile to create the calendar within.
+    # name       - A String to use as the name of the calendar.
+    #
+    # See http://www.cronofy.com/developers/api/alpah#create-calendar for
+    # reference.
+    #
+    # Returns the created Calendar
+    #
+    # 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::AccountLockedError if the profile is not in a writable
+    # state and so a calendar cannot be created.
+    # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
+    # limits for the application.
+    def create_calendar(profile_id, name)
+      response = post("/v1/calendars", profile_id: profile_id, name: name)
+      parse_json(Calendar, "calendar", response)
+    end
+
     # Public: Lists all the calendars for the account.
     #
     # See http://www.cronofy.com/developers/api#calendars for reference.
@@ -269,6 +295,18 @@ module Cronofy
     # Public: Creates a notification channel with a callback URL
     #
     # callback_url - A String specifing the callback URL for the channel.
+    # options      - The Hash options used to refine the notifications of the
+    #                channel (default: {}):
+    #                :filters - A Hash of filters to use for the notification
+    #                           channel (optional):
+    #                           :calendar_ids - An Array of calendar ID strings
+    #                                           to restrict the returned events
+    #                                           to (optional).
+    #                           :only_managed - A Boolean specifying whether
+    #                                           only events that you are
+    #                                           managing for the account should
+    #                                           trigger notifications
+    #                                           (optional).
     #
     # See http://www.cronofy.com/developers/api#create-channel for reference.
     #
@@ -283,8 +321,10 @@ module Cronofy
     # parameters.
     # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
     # limits for the application.
-    def create_channel(callback_url)
-      response = post("/v1/channels", callback_url: callback_url)
+    def create_channel(callback_url, options = {})
+      params = options.merge(callback_url: callback_url)
+
+      response = post("/v1/channels", params)
       parse_json(Channel, "channel", response)
     end
 

data/lib/cronofy/errors.rb

@@ -52,9 +52,15 @@ module Cronofy
     end
   end
 
+  class AccountLockedError < APIError
+  end
+
   class TooManyRequestsError < APIError
   end
 
+  class ServerError < APIError
+  end
+
   class UnknownError < APIError
   end
 
@@ -66,7 +72,9 @@ module Cronofy
       403 => AuthorizationFailureError,
       404 => NotFoundError,
       422 => InvalidRequestError,
+      423 => AccountLockedError,
       429 => TooManyRequestsError,
+      500 => ServerError,
     }.freeze
 
     def self.map_error(error)

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.8.3".freeze
+  VERSION = "0.9.0".freeze
 end

data/spec/lib/cronofy/client_spec.rb

@@ -102,7 +102,17 @@ describe Cronofy::Client do
       expect{ subject }.to raise_error(::Cronofy::InvalidRequestError)
     end
 
-    it 'raises AuthenticationFailureError on 401s' do
+    it 'raises AccountLockedError on 423s' do
+      stub_request(method, request_url)
+        .with(headers: request_headers,
+              body: request_body)
+        .to_return(status: 423,
+                   headers: correct_response_headers,
+                   body: correct_response_body.to_json)
+      expect{ subject }.to raise_error(::Cronofy::AccountLockedError)
+    end
+
+    it 'raises TooManyRequestsError on 429s' do
       stub_request(method, request_url)
         .with(headers: request_headers,
               body: request_body)
@@ -111,6 +121,50 @@ describe Cronofy::Client do
                    body: correct_response_body.to_json)
       expect{ subject }.to raise_error(::Cronofy::TooManyRequestsError)
     end
+
+    it 'raises ServerError on 500s' do
+      stub_request(method, request_url)
+        .with(headers: request_headers,
+              body: request_body)
+        .to_return(status: 500,
+                   headers: correct_response_headers,
+                   body: correct_response_body.to_json)
+      expect{ subject }.to raise_error(::Cronofy::ServerError)
+    end
+  end
+
+  describe '#create_calendar' do
+    let(:request_url) { 'https://api.cronofy.com/v1/calendars' }
+    let(:method) { :post }
+    let(:request_body) do
+      {
+        :profile_id => "pro_1234",
+        :name => "Home",
+      }
+    end
+
+    let(:correct_response_code) { 200 }
+    let(:correct_response_body) do
+      {
+        "calendar" => {
+          "provider_name" => "google",
+          "profile_name" => "example@cronofy.com",
+          "calendar_id" => "cal_n23kjnwrw2_jsdfjksn234",
+          "calendar_name" => "Home",
+          "calendar_readonly" => false,
+          "calendar_deleted" => false
+        }
+      }
+    end
+
+    let(:correct_mapped_result) do
+      Cronofy::Calendar.new(correct_response_body["calendar"])
+    end
+
+    subject { client.create_calendar("pro_1234", "Home") }
+
+    it_behaves_like 'a Cronofy request'
+    it_behaves_like 'a Cronofy request with mapped return value'
   end
 
   describe '#list_calendars' do
@@ -177,14 +231,16 @@ describe Cronofy::Client do
         }
       end
       let(:request_body) do
-        hash_including(:event_id => "qTtZdczOccgaPncGJaCiLg",
-                       :summary => "Board meeting",
-                       :description => "Discuss plans for the next quarter.",
-                       :start => encoded_start_datetime,
-                       :end => encoded_end_datetime,
-                       :location => {
-                         :description => "Board room"
-                       })
+        {
+          :event_id => "qTtZdczOccgaPncGJaCiLg",
+          :summary => "Board meeting",
+          :description => "Discuss plans for the next quarter.",
+          :start => encoded_start_datetime,
+          :end => encoded_end_datetime,
+          :location => {
+            :description => "Board room"
+          }
+        }
       end
       let(:correct_response_code) { 202 }
       let(:correct_response_body) { nil }
@@ -391,6 +447,24 @@ describe Cronofy::Client do
         it_behaves_like 'a Cronofy request with mapped return value'
       end
 
+      context "when calendar_ids are passed" do
+        let(:params) do
+          {
+            calendar_ids: ["cal_1234_abcd", "cal_1234_efgh", "cal_5678_ijkl"],
+          }
+        end
+
+        let(:request_url) do
+          "#{request_url_prefix}?tzid=Etc/UTC" \
+          "&calendar_ids[]=cal_1234_abcd" \
+          "&calendar_ids[]=cal_1234_efgh" \
+          "&calendar_ids[]=cal_5678_ijkl"
+        end
+
+        it_behaves_like 'a Cronofy request'
+        it_behaves_like 'a Cronofy request with mapped return value'
+      end
+
       context "next page not found" do
         before do
           stub_request(:get, next_page_url)
@@ -474,7 +548,6 @@ describe Cronofy::Client do
       let(:method) { :post }
       let(:callback_url) { 'http://call.back/url' }
       let(:request_headers) { json_request_headers }
-      let(:request_body) { hash_including(:callback_url => callback_url) }
 
       let(:correct_response_code) { 200 }
       let(:correct_response_body) do
@@ -491,10 +564,40 @@ describe Cronofy::Client do
         Cronofy::Channel.new(correct_response_body["channel"])
       end
 
-      subject { client.create_channel(callback_url) }
+      context "with filters" do
+        let(:request_body) do
+          {
+            callback_url: callback_url,
+            filters: filters,
+          }
+        end
 
-      it_behaves_like 'a Cronofy request'
-      it_behaves_like 'a Cronofy request with mapped return value'
+        let(:filters) do
+          {
+            calendar_ids: ["cal_1234_abcd", "cal_1234_efgh", "cal_5678_ijkl"],
+            only_managed: true,
+            future_parameter: "for flexibility",
+          }
+        end
+
+        subject { client.create_channel(callback_url, filters: filters) }
+
+        it_behaves_like 'a Cronofy request'
+        it_behaves_like 'a Cronofy request with mapped return value'
+      end
+
+      context "without filters" do
+        let(:request_body) do
+          {
+            callback_url: callback_url,
+          }
+        end
+
+        subject { client.create_channel(callback_url) }
+
+        it_behaves_like 'a Cronofy request'
+        it_behaves_like 'a Cronofy request with mapped return value'
+      end
     end
 
     describe '#list_channels' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-26 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2