bookingsync-api 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21ea86e95a6baf65805f5245e7122a19bee233b1
-  data.tar.gz: b28efa9f653d940025fd2c3634d28194db9d491e
+  metadata.gz: ce66e1f4e1cc24f2a8b0cef1b32a25aab9ff1d9a
+  data.tar.gz: f47f52988544b9077a593b28608e64cc8c541c1c
 SHA512:
-  metadata.gz: fc6dd487a46aac96d5f79defb481e67e724ea4cc1888509b3838582bb06118a7bd03be5067951daf5aa6384fadea529a5c2edf94ed9fc91bcb0e095cd49a4de5
-  data.tar.gz: 290ef32d85ef0fe7b62d7bda949012e2dd2f4e59f83f46907c5363b5efd78375a71cf66b5b5335752ea76501c44dba4712d35ffa944adfbafca20403af6cef18
+  metadata.gz: 25f4e1764280d93fef798b6d0e911f0f848d14858c2d3cedbf790671719b62a068ce5451fa2e67f7d934bd09d042f95ceb4de50b0fb8ec43bdc95056088bb8ae
+  data.tar.gz: 459ee676056b24da21febbf25203c3b7537f0fdaa90721a7be4e979662d41ff4112b20ba0cfcb27cb66976242cc10da4c751e606722be6179866546312b7416a

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 0.1.5
+
+- `Bookings#cancel_booking` supports passing attributes in body.
+
 ## 0.1.4
 
 - Drop support for `preferences_payments`.

data/lib/bookingsync/api/client/bookings.rb

@@ -70,9 +70,17 @@ module BookingSync::API
       #
       # @param booking [BookingSync::API::Resource|Integer] Booking or ID of
       #   the booking to be canceled.
+      # @param options [Hash] Booking attributes to be updated.
+      #   (For now, only `cancelation_reason` is allowed)
       # @return [NilClass] Returns nil on success.
-      def cancel_booking(booking, options = {})
-        delete "bookings/#{booking}"
+      # @example
+      #   @api.cancel_booking(booking_id)
+      #
+      # @example Providing cancelation_reason
+      #   @api.cancel_booking(booking_id, { cancelation_reason: "payment_failed" })
+      def cancel_booking(booking, options = nil)
+        options = { bookings: [options] } if options
+        delete "bookings/#{booking}", options
       end
     end
   end

data/lib/bookingsync/api/version.rb

@@ -1,5 +1,5 @@
 module BookingSync
   module API
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

data/spec/bookingsync/api/client/bookings_spec.rb

@@ -109,13 +109,12 @@ describe BookingSync::API::Client::Bookings do
   end
 
   describe ".cancel_booking", :vcr do
-    let(:created_booking_id) {
-      find_resource("#{@casette_base_path}_create_booking/creates_a_booking.yml", "bookings")[:id]
-    }
+    let(:booking_id_to_be_canceled) { 796 }
 
-    it "cancels given booking" do
-      client.cancel_booking(created_booking_id)
-      assert_requested :delete, bs_url("bookings/#{created_booking_id}")
+    it "cancels given booking and passes options along as bookings payload" do
+      client.cancel_booking(booking_id_to_be_canceled, cancelation_reason: "payment_failed")
+      assert_requested :delete, bs_url("bookings/#{booking_id_to_be_canceled}"),
+        body: { bookings: [{ cancelation_reason: "payment_failed" }] }.to_json
     end
   end
 end

data/spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_cancel_booking/{cancels_given_booking.yml → cancels_given_booking_and_passes_options_along_as_bookings_payload.yml}

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: delete
-    uri: https://www.bookingsync.com/api/v3/bookings/840043
+    uri: https://www.bookingsync.com/api/v3/bookings/796
     body:
       encoding: UTF-8
-      string: "{}"
+      string: '{"bookings":[{"cancelation_reason":"payment_failed"}]}'
     headers:
       User-Agent:
-      - BookingSync API gem v0.1.3
+      - BookingSync API gem v0.1.4
       Accept:
       - application/vnd.api+json
       Content-Type:
@@ -26,14 +26,6 @@ http_interactions:
       code: 204
       message: No Content
     headers:
-      Server:
-      - nginx
-      Date:
-      - Mon, 12 Dec 2016 12:13:17 GMT
-      Connection:
-      - keep-alive
-      Status:
-      - 204 No Content
       X-Frame-Options:
       - SAMEORIGIN
       X-Xss-Protection:
@@ -41,33 +33,33 @@ http_interactions:
       X-Content-Type-Options:
       - nosniff
       X-Updated-Since-Request-Synced-At:
-      - 2016-12-12 12:13:16 UTC
+      - 2017-06-21 17:31:45 UTC
       X-Ratelimit-Limit:
       - '1000'
       X-Ratelimit-Reset:
-      - '1481547600'
+      - '1498068000'
       X-Ratelimit-Remaining:
-      - '974'
+      - '999'
       Cache-Control:
       - no-cache
       P3p:
       - CP="OTI DSP COR CUR ADMo DEVo TAI PSAi PSDi IVAi IVDi CONi HISi TELi OTPi
         OUR SAMi OTRo UNRo PUBi IND UNI STA"
       Set-Cookie:
-      - ahoy_track=true; path=/; secure
-      - ahoy_visit=787c8bd2-11eb-42f0-bd08-d353187a4782; path=/; expires=Mon, 19 Dec
-        2016 12:13:16 -0000; secure
-      - ahoy_visitor=113ed9a0-fc74-4c3c-be2c-5e177a24d93a; path=/; expires=Wed, 12
-        Dec 2018 12:13:16 -0000; secure
+      - ahoy_track=true; path=/
+      - ahoy_visit=3fbaacc4-8804-4d56-b04b-a5c73776f30f; path=/; expires=Wed, 28 Jun
+        2017 17:31:45 -0000
+      - ahoy_visitor=fdfdf051-d834-454d-b972-b7185b40cc22; path=/; expires=Fri, 21
+        Jun 2019 17:31:45 -0000
       X-Request-Id:
-      - 8269520e-314d-42b8-9132-8eed54676b1f
+      - b0d60bfe-47b5-42a7-9561-1c1cae003ce1
       X-Runtime:
-      - '0.167782'
-      Strict-Transport-Security:
-      - max-age=31536000
+      - '6.442512'
+      Connection:
+      - close
     body:
       encoding: UTF-8
       string: ''
-    http_version: 
-  recorded_at: Mon, 12 Dec 2016 12:13:17 GMT
-recorded_with: VCR 3.0.3
+    http_version:
+  recorded_at: Wed, 21 Jun 2017 17:31:50 GMT
+recorded_with: VCR 2.9.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bookingsync-api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Sébastien Grosjean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2017-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -244,7 +244,7 @@ files:
 - spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_bookings/pagination/with_auto_paginate_true/returns_all_bookings_joined_from_many_requests.yml
 - spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_bookings/pagination/with_per_page_setting/returns_limited_number_of_bookings.yml
 - spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_bookings/returns_bookings.yml
-- spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_cancel_booking/cancels_given_booking.yml
+- spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_cancel_booking/cancels_given_booking_and_passes_options_along_as_bookings_payload.yml
 - spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_create_booking/creates_a_booking.yml
 - spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_edit_booking/updates_given_booking_by_ID.yml
 - spec/fixtures/cassettes/BookingSync_API_Client_BookingsFees/_bookings_fee/returns_a_single_bookings_fee.yml
@@ -386,7 +386,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby interface for accessing https://www.bookingsync.com
@@ -463,7 +463,7 @@ test_files:
 - spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_bookings/pagination/with_auto_paginate_true/returns_all_bookings_joined_from_many_requests.yml
 - spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_bookings/pagination/with_per_page_setting/returns_limited_number_of_bookings.yml
 - spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_bookings/returns_bookings.yml
-- spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_cancel_booking/cancels_given_booking.yml
+- spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_cancel_booking/cancels_given_booking_and_passes_options_along_as_bookings_payload.yml
 - spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_create_booking/creates_a_booking.yml
 - spec/fixtures/cassettes/BookingSync_API_Client_Bookings/_edit_booking/updates_given_booking_by_ID.yml
 - spec/fixtures/cassettes/BookingSync_API_Client_BookingsFees/_bookings_fee/returns_a_single_bookings_fee.yml
@@ -585,3 +585,4 @@ test_files:
 - spec/fixtures/files/test.jpg
 - spec/spec_helper.rb
 - spec/support/vcr_helper.rb
+has_rdoc: