cronofy 0.24.1 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 639cf154e0bae1368e59a8c506f52dcdd0d80d7d
-  data.tar.gz: cc17141d1b0eb4b1710dd7a90773a61bfca76e00
+  metadata.gz: bed8b488fc8541bce5c97cd5295059a35b11712d
+  data.tar.gz: 98a3c423e351ec564a4ff3456b1ba6149614cd7e
 SHA512:
-  metadata.gz: 8c0bbd381139093ebf7ae94c5004ad9099bdcbb9a6aee097a9e8e2d0d1f86b3edeb5e89c9657a294f62360b997cc0b03079e454ad739866aebda7d2360083da3
-  data.tar.gz: 4a8f8cb63977c3364e8acdf5c46fa4f4eabacf29de6d5768b4507061241afe6d78de927d3abfef75e58c0483752c523269ec56f59ba8022db98824f68b1208f5
+  metadata.gz: fd6f0a7779ba848f996df1339cf1e353948a2c12f47c9e79ab0e29cf8a92e4b5075d3077e4e7118adad395885aa19d3e5679c903219dafad1eedf4ec056d7523
+  data.tar.gz: c6adc9c8be4946c7b018c704b5b5850ef7abdd09619e396664a6b0d52b72e6e2e03584a83df30279e0dcba818765d6cc96776a667b2143d0f04cafff7492804d

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.25.0]
+
+ * Support for Smart Invites [#49]
+ * Fix warning in Ruby 2.4 [#50]
+
 ## [0.24.1]
 
  * Disable Hashie warnings [#52]
@@ -80,6 +85,7 @@
 [0.23.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.23.0
 [0.24.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.24.0
 [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
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -101,4 +107,6 @@
 [#45]: https://github.com/cronofy/cronofy-ruby/pull/45
 [#46]: https://github.com/cronofy/cronofy-ruby/pull/46
 [#48]: https://github.com/cronofy/cronofy-ruby/pull/48
+[#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

data/lib/cronofy.rb

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

data/lib/cronofy/api_key.rb

@@ -0,0 +1,73 @@
+require "oauth2"
+
+module Cronofy
+  class ApiKey
+    def initialize(client, client_secret)
+      @client = client
+      @client_secret = client_secret
+    end
+
+    # Make a request with the API Key
+    #
+    # @param [Symbol] verb the HTTP request method
+    # @param [String] path the HTTP URL path of the request
+    # @param [Hash] opts the options to make the request with
+    # @see Client#request
+    def request(verb, path, opts = {}, &block)
+      configure_authentication!(opts)
+      do_request { @client.request(verb, path, opts, &block) }
+    end
+
+    # Make a GET request with the API Key
+    #
+    # @see ApiKey#request
+    def get(path, opts = {}, &block)
+      request(:get, path, opts, &block)
+    end
+
+    # Make a POST request with the API Key
+    #
+    # @see ApiKey#request
+    def post(path, opts = {}, &block)
+      request(:post, path, opts, &block)
+    end
+
+    # Make a PUT request with the API Key
+    #
+    # @see ApiKey#request
+    def put(path, opts = {}, &block)
+      request(:put, path, opts, &block)
+    end
+
+    # Make a PATCH request with the API Key
+    #
+    # @see ApiKey#request
+    def patch(path, opts = {}, &block)
+      request(:patch, path, opts, &block)
+    end
+
+    private
+
+    def headers
+      {'Authorization' => "Bearer #{@client_secret}"}
+    end
+
+    def configure_authentication!(opts)
+      opts[:headers] ||= {}
+      opts[:headers].merge!(headers)
+    end
+
+    def do_request(&block)
+      if blank?(@client_secret)
+        raise CredentialsMissingError.new("OAuth client_id and client_secret must be set")
+      end
+      block.call
+    rescue OAuth2::Error => e
+      raise Errors.map_error(e)
+    end
+
+    def blank?(value)
+      value.nil? || value.strip.empty?
+    end
+  end
+end

data/lib/cronofy/auth.rb

@@ -4,6 +4,7 @@ module Cronofy
   # Internal: Class for dealing with authentication and authorization issues.
   class Auth
     attr_reader :access_token
+    attr_reader :api_key
 
     def initialize(options = {})
       access_token = options[:access_token]
@@ -18,6 +19,7 @@ module Cronofy
       @api_client = OAuth2::Client.new(client_id, client_secret, site: ::Cronofy.api_url(data_centre), connection_opts: { headers: { "User-Agent" => "Cronofy Ruby #{::Cronofy::VERSION}" } })
 
       set_access_token(access_token, refresh_token) if access_token || refresh_token
+      set_api_key(client_secret) if client_secret
     end
 
     # Internal: generate a URL for authorizing the application with Cronofy
@@ -81,6 +83,10 @@ module Cronofy
       @access_token = OAuth2::AccessToken.new(@api_client, token, refresh_token: refresh_token)
     end
 
+    def set_api_key(client_secret)
+      @api_key = ApiKey.new(@api_client, client_secret)
+    end
+
     # Internal: Revokes the refresh token and corresponding access tokens.
     #
     # Returns nothing.

data/lib/cronofy/client.rb

@@ -974,6 +974,105 @@ module Cronofy
       nil
     end
 
+    # Public: Creates or updates smart invite.
+    #
+    # smart_invite_id - A String uniquely identifying the event for your
+    #                  application (note: this is NOT an ID generated
+    #                  by Cronofy).
+    # callback_url  - The URL within your application you want Cronofy to
+    #                 send notifications to about user interactions with
+    #                 the Smart Invite.
+    # recipient     - A Hash containing the intended recipient of the invite
+    #                 :email      - A String for thee email address you are
+    #                               going to send the Smart Invite to.
+    # event         - A Hash describing the event with symbolized keys:
+    #                 :summary      - A String to use as the summary, sometimes
+    #                                 referred to as the name or title, of the
+    #                                 event.
+    #                 :description  - A String to use as the description, sometimes
+    #                                 referred to as the notes or body, of the
+    #                                 event.
+    #                 :start        - The Time or Date the event starts.
+    #                 :end          - The Time or Date the event ends.
+    #                 :url          - The URL associated with the event.
+    #                 :location     - A Hash describing the location of the event
+    #                                 with symbolized keys (optional):
+    #                                 :description - A String describing the
+    #                                                location.
+    #                                 :lat - A String of the location's latitude.
+    #                                 :long - A String of the location's longitude.
+    #                 :reminders    - An Array of Hashes describing the desired
+    #                                 reminders for the event. Reminders should be
+    #                                 specified in priority order as, for example,
+    #                                 when the underlying provider only supports a
+    #                                 single reminder then the first reminder will
+    #                                 be used.
+    #                                 :minutes - An Integer specifying the number
+    #                                            of minutes before the start of the
+    #                                            event that the reminder should
+    #                                            occur.
+    #                 :transparency - The transparency state for the event (optional).
+    #                                 Accepted values are "transparent" and "opaque".
+    #                 :color        - The color of the event (optional).
+    #
+    # Examples
+    #
+    #   client.upsert_smart_invite(
+    #     smart_invite_id: "qTtZdczOccgaPncGJaCiLg",
+    #     callback_url: "http://www.example.com",
+    #     attendee: {
+    #       email: "example@example.com"
+    #     },
+    #     event: {
+    #       summary: "Board meeting",
+    #       description: "Discuss plans for the next quarter.",
+    #       start: Time.utc(2014, 8, 5, 15, 30),
+    #       end:   Time.utc(2014, 8, 5, 17, 30),
+    #       location: {
+    #         description: "Board room",
+    #         lat: "1.2345",
+    #         long: "0.1234"
+    #     }
+    #   )
+    #
+    # See http://www.cronofy.com/developers/alpha/api#smart-invite for reference.
+    #
+    # Returns a SmartInviteResponse.
+    #
+    # 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_smart_invite(body={})
+      body[:event][:start] = encode_event_time(body[:event][:start])
+      body[:event][:end] = encode_event_time(body[:event][:end])
+
+      response = wrapped_request { api_key!.post("/v1/smart_invites", json_request_args(body)) }
+      parse_json(SmartInviteResponse, nil, response)
+    end
+
+    # Public: Gets the details for a smart invite.
+    #
+    # smart_invite_id  - A String uniquely identifying the event for your
+    #                   application (note: this is NOT an ID generated
+    #                   by Cronofy).
+    # recipient_email - The email address for the recipient to get details for.
+    #
+    # See http://www.cronofy.com/developers/alpha/api#smart-invite for reference.
+    #
+    # Returns a SmartInviteResponse.
+    #
+    # 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_smart_invite(smart_invite_id, recipient_email)
+      response = wrapped_request { api_key!.get("/v1/smart_invites?recipient_email=#{recipient_email}&smart_invite_id=#{smart_invite_id}") }
+      parse_json(SmartInviteResponse, nil, response)
+    end
+
     private
 
     def translate_available_periods(periods)
@@ -1035,7 +1134,7 @@ module Cronofy
 
     def map_availability_required_duration(required_duration)
       case required_duration
-      when Fixnum
+      when Integer
         { minutes: required_duration }
       else
         required_duration
@@ -1065,6 +1164,11 @@ module Cronofy
       @auth.access_token
     end
 
+    def api_key!
+      raise CredentialsMissingError.new unless @auth.api_key
+      @auth.api_key
+    end
+
     def get(url, opts = {})
       wrapped_request { access_token!.get(url, opts) }
     end

data/lib/cronofy/types.rb

@@ -283,6 +283,9 @@ module Cronofy
   class AddToCalendarResponse < CronofyMash
   end
 
+  class SmartInviteResponse < Hashie::Mash
+  end
+
   module ParticipantEnumerable
     def self.coerce(values)
       values.map { |v| Participant.new(v) }

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.24.1".freeze
+  VERSION = "0.25.0".freeze
 end

data/spec/lib/cronofy/client_spec.rb

@@ -1744,4 +1744,86 @@ describe Cronofy::Client do
       expect(client.hmac_match?(body: body, hmac: "something-else")).to be false
     end
   end
+
+  describe "Smart Invite" do
+    let(:request_url) { "https://api.cronofy.com/v1/smart_invites" }
+    let(:url) { URI("https://example.com") }
+    let(:method) { :post }
+
+    let(:request_headers) do
+      {
+        "Authorization" => "Bearer #{client_secret}",
+        "User-Agent" => "Cronofy Ruby #{::Cronofy::VERSION}",
+        "Content-Type" => "application/json; charset=utf-8",
+      }
+    end
+
+    let(:location) { { :description => "Board room" } }
+    let(:client_id) { 'example_id' }
+    let(:client_secret) { 'example_secret' }
+
+    let(:client) do
+      Cronofy::Client.new(
+        client_id: client_id,
+        client_secret: client_secret,
+      )
+    end
+
+    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(:args) do
+      {
+        smart_invite_id: "qTtZdczOccgaPncGJaCiLg",
+        callback_url: url.to_s,
+        event: {
+          :summary => "Board meeting",
+          :description => "Discuss plans for the next quarter.",
+          :url => url.to_s,
+          :start => start_datetime,
+          :end => encoded_end_datetime,
+          :location => location,
+          :reminders => [
+            { :minutes => 60 },
+            { :minutes => 0 },
+            { :minutes => 10 },
+          ],
+        },
+      }
+    end
+
+    let(:request_body) do
+      {
+        smart_invite_id: "qTtZdczOccgaPncGJaCiLg",
+        callback_url: url.to_s,
+        event: {
+          :summary => "Board meeting",
+          :description => "Discuss plans for the next quarter.",
+          :url => url.to_s,
+          :start => encoded_start_datetime,
+          :end => encoded_end_datetime,
+          :location => location,
+          :reminders => [
+            { :minutes => 60 },
+            { :minutes => 0 },
+            { :minutes => 10 },
+          ],
+        },
+      }
+    end
+    let(:correct_response_code) { 202 }
+    let(:correct_response_body) do
+      request_body.merge({
+        attachments: []
+      })
+    end
+
+    subject { client.upsert_smart_invite(request_body) }
+
+    it_behaves_like 'a Cronofy request'
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.24.1
+  version: 0.25.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2017-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -116,6 +116,7 @@ files:
 - Rakefile
 - cronofy.gemspec
 - lib/cronofy.rb
+- lib/cronofy/api_key.rb
 - lib/cronofy/auth.rb
 - lib/cronofy/client.rb
 - lib/cronofy/errors.rb
@@ -149,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Cronofy - one API for all the calendars