cronofy 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a48c75251078b9b71b6921cb317f6691a9add421
-  data.tar.gz: b616264212a442276812c5a4a8d944d34e4ba500
+  metadata.gz: f49556775f54db6e9d33b86eb11a597abd666d74
+  data.tar.gz: b1fcdc132ab95869f21173f4e5b2f0d07f75ae89
 SHA512:
-  metadata.gz: 18fb8765fa73771e8b19fdd58e6d349dd792cc82d9e2f8cc817341722e461b74e2d28d7133ddae470ff58cf41441d9dc6b77db118de23e7383586dfa3a44cd61
-  data.tar.gz: 39a63b0cdf4d63ce838fdbac5bb94d5f8bf6e3cf37b7102760b4f925f4adcfd12b08224dd64a8ce6c570a299074a8f1f4e4529badfb61102c94f96e8c1fcaa45
+  metadata.gz: 079b7acfd635b54c5455e729825e501ed0a98468b0879159ea5bb7949ca0088e41cddbc55d139a8de077e864403a643e4fc5d8f2e656c001921a1a8ba500b5c1
+  data.tar.gz: 9c21a0271003820802875da88e19b8fa157e37720ac2f5c434ec3cd8d1b945c7220b3fce18071b2c02f402ee6b8fd88d1fe871651a6e019bc8edd74e8d900d01

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.23.0]
+
+ * Support for color with calendar creation and event upsert [#46]
+ * Helper to verify push notification HMACs [#45]
+
 ## [0.22.0]
 
  * Splitting of Add to Calendar and Real time scheduling [#44]
@@ -64,6 +69,7 @@
 [0.20.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.20.0
 [0.21.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.21.0
 [0.22.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.22.0
+[0.23.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.23.0
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -82,3 +88,5 @@
 [#40]: https://github.com/cronofy/cronofy-ruby/pull/40
 [#43]: https://github.com/cronofy/cronofy-ruby/pull/43
 [#44]: https://github.com/cronofy/cronofy-ruby/pull/44
+[#45]: https://github.com/cronofy/cronofy-ruby/pull/45
+[#46]: https://github.com/cronofy/cronofy-ruby/pull/46

data/lib/cronofy.rb

@@ -4,7 +4,10 @@ require "cronofy/types"
 require "cronofy/auth"
 require "cronofy/client"
 require "cronofy/response_parser"
+
+require 'base64'
 require 'json'
+require 'openssl'
 
 module Cronofy
   def self.default_data_centre

data/lib/cronofy/client.rb

@@ -42,13 +42,15 @@ module Cronofy
       )
     end
 
-    # Public: Creates a new calendar for the account.
+    # Public: Creates a new calendar for the profile.
     #
     # profile_id - The String ID of the profile to create the calendar within.
-    # name       - A String to use as the name of the calendar.
+    # name       - The String to use as the name of the calendar.
+    # options    - The Hash options used to customize the calendar
+    #              (default: {}):
+    #              :color - The color to make the calendar (optional).
     #
-    # See http://www.cronofy.com/developers/api/alpah#create-calendar for
-    # reference.
+    # See https://www.cronofy.com/developers/api/#create-calendar for reference.
     #
     # Returns the created Calendar
     #
@@ -63,8 +65,9 @@ module Cronofy
     # 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)
+    def create_calendar(profile_id, name, options = {})
+      request = options.merge(profile_id: profile_id, name: name)
+      response = post("/v1/calendars", request)
       parse_json(Calendar, "calendar", response)
     end
 
@@ -120,6 +123,7 @@ module Cronofy
     #                                          occur.
     #               :transparency - The transparency state for the event (optional).
     #                               Accepted values are "transparent" and "opaque".
+    #               :color        - The color of the event (optional).
     #               :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
@@ -254,7 +258,7 @@ module Cronofy
     # The first page will be retrieved eagerly so that common errors will happen
     # inline. However, subsequent pages (if any) will be requested lazily.
     #
-    # See http://www.cronofy.com/developers/api/alpha#free-busy for reference.
+    # See http://www.cronofy.com/developers/api/#free-busy for reference.
     #
     # Returns a lazily-evaluated Enumerable of FreeBusy
     #
@@ -394,6 +398,26 @@ module Cronofy
       parse_json(Channel, "channel", response)
     end
 
+    # Public: Verifies a HMAC from a push notification using the client secret.
+    #
+    # args - A Hash containing the details of the push notification:
+    #        :body - A String of the body of the notification.
+    #        :hmac - A String of the HMAC of the notification taken from the
+    #                Cronofy-HMAC-SHA256 header.
+    #
+    # Returns true if the HMAC provided matches the one calculated using the
+    # client secret, otherwise false.
+    def hmac_match?(args)
+      body = args[:body]
+      hmac = args[:hmac]
+
+      sha256 = OpenSSL::Digest.new('sha256')
+      digest = OpenSSL::HMAC.digest(sha256, @client_secret, body)
+      calculated = Base64.encode64(digest).strip
+
+      calculated == hmac
+    end
+
     # Public: Lists all the notification channels for the account.
     #
     # See http://www.cronofy.com/developers/api#list-channels for reference.
@@ -453,7 +477,7 @@ module Cronofy
 
     # Public: Lists all the profiles for the account.
     #
-    # See https://www.cronofy.com/developers/api/alpha/#profiles for reference.
+    # See https://www.cronofy.com/developers/api/#profiles for reference.
     #
     # Returns an Array of Profiles
     #

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.22.0".freeze
+  VERSION = "0.23.0".freeze
 end

data/spec/lib/cronofy/client_spec.rb

@@ -136,12 +136,10 @@ describe Cronofy::Client do
   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(:profile_id) { "pro_1234" }
+    let(:calendar_name) { "Home" }
+    let(:color) { "#49BED8" }
 
     let(:correct_response_code) { 200 }
     let(:correct_response_body) do
@@ -161,10 +159,34 @@ describe Cronofy::Client do
       Cronofy::Calendar.new(correct_response_body["calendar"])
     end
 
-    subject { client.create_calendar("pro_1234", "Home") }
+    context "with mandatory arguments" do
+      let(:request_body) do
+        {
+          profile_id: profile_id,
+          name: calendar_name,
+        }
+      end
 
-    it_behaves_like 'a Cronofy request'
-    it_behaves_like 'a Cronofy request with mapped return value'
+      subject { client.create_calendar(profile_id, calendar_name) }
+
+      it_behaves_like 'a Cronofy request'
+      it_behaves_like 'a Cronofy request with mapped return value'
+    end
+
+    context "with color" do
+      let(:request_body) do
+        {
+          profile_id: profile_id,
+          name: calendar_name,
+          color: color,
+        }
+      end
+
+      subject { client.create_calendar(profile_id, calendar_name, color: color) }
+
+      it_behaves_like 'a Cronofy request'
+      it_behaves_like 'a Cronofy request with mapped return value'
+    end
   end
 
   describe '#list_calendars' do
@@ -1688,4 +1710,24 @@ describe Cronofy::Client do
       end
     end
   end
+
+  describe "HMAC verification" do
+    let(:client) do
+      Cronofy::Client.new(
+        client_secret: 'pDY0Oi7TJSP2hfNmZNkm5',
+        access_token: token,
+        refresh_token: 'refresh_token_456',
+      )
+    end
+
+    let(:body) { "{\"example\":\"well-known\"}" }
+
+    it "verifies the correct HMAC" do
+      expect(client.hmac_match?(body: body, hmac: "6r2/HjBkqymGegX0wOfifieeUXbbHwtV/LohHS+jv6c=")).to be true
+    end
+
+    it "rejects an incorrect HMAC" do
+      expect(client.hmac_match?(body: body, hmac: "something-else")).to be false
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-09 00:00:00.000000000 Z
+date: 2017-07-21 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.12
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Cronofy - one API for all the calendars