bookingsync-api 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6915dfa213253a45f23f6ce051ac640ced0823b7
-  data.tar.gz: a799e2b306a6adb73939bab9ea6aa2ab63693a9f
+  metadata.gz: 21ea86e95a6baf65805f5245e7122a19bee233b1
+  data.tar.gz: b28efa9f653d940025fd2c3634d28194db9d491e
 SHA512:
-  metadata.gz: af88da09b10078bb703df8da722f11cac55cde73df7982400c84d1912642d1726717be0210a235048dc1a1d704d6533eb632daa35ca1d55484d0c2dafa45a084
-  data.tar.gz: 2629e80e6e1461153041c3920d73ac6ae0b8f42eedad7ef4bbbd1645f4014182543e825c3de25c295a03d3af4030de00d1536f1e63e0dad3a5c5d134eb49f0ef
+  metadata.gz: fc6dd487a46aac96d5f79defb481e67e724ea4cc1888509b3838582bb06118a7bd03be5067951daf5aa6384fadea529a5c2edf94ed9fc91bcb0e095cd49a4de5
+  data.tar.gz: 290ef32d85ef0fe7b62d7bda949012e2dd2f4e59f83f46907c5363b5efd78375a71cf66b5b5335752ea76501c44dba4712d35ffa944adfbafca20403af6cef18

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master
 
+## 0.1.4
+
+- Drop support for `preferences_payments`.
+- Switch from `Net::HTTP` to `Net::HTTP::Persistent`.
+- [bugfix] Fix bug when paginate with block didn't invoke it, if only one page of results was returned.
+
 ## 0.1.3
 
 - Expose pagination_first_request to easily retrieve right timestamps for updated since syncs.

data/bookingsync-api.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "net-http-persistent", "~> 2"
   spec.add_dependency "hashie"
   spec.add_dependency "addressable"
   spec.add_development_dependency "bundler", "~> 1.5"

data/lib/bookingsync/api/client.rb

@@ -21,7 +21,6 @@ require "bookingsync/api/client/periods"
 require "bookingsync/api/client/payments"
 require "bookingsync/api/client/payment_gateways"
 require "bookingsync/api/client/preferences_general_settings"
-require "bookingsync/api/client/preferences_payments"
 require "bookingsync/api/client/photos"
 require "bookingsync/api/client/rates"
 require "bookingsync/api/client/rates_rules"
@@ -70,7 +69,6 @@ module BookingSync::API
     include BookingSync::API::Client::Payments
     include BookingSync::API::Client::PaymentGateways
     include BookingSync::API::Client::PreferencesGeneralSettings
-    include BookingSync::API::Client::PreferencesPayments
     include BookingSync::API::Client::Photos
     include BookingSync::API::Client::Rates
     include BookingSync::API::Client::RatesRules
@@ -203,28 +201,15 @@ module BookingSync::API
     # @return [Array<BookingSync::API::Resource>] Batch of resources
     def paginate(path, options = {}, &block)
       instrument("paginate.bookingsync_api", path: path) do
-        auto_paginate = options.delete(:auto_paginate)
-        request_method =  options.delete(:request_method) || :get
-        if request_method == :get
-          response = call(request_method, path, query: options)
+        request_settings = {
+          auto_paginate: options.delete(:auto_paginate),
+          request_method: options.delete(:request_method) || :get
+        }
+
+        if block_given?
+          data = fetch_with_block(path, options, request_settings, &block)
         else
-          response = call(request_method, path, options)
-        end
-        @pagination_first_response = response
-        data = response.resources.dup
-
-        if (block_given? || auto_paginate) && response.relations[:next]
-          first_request = true
-          loop do
-            if block_given?
-              yield(response.resources)
-            elsif auto_paginate
-              data.concat(response.resources) unless first_request
-              first_request = false
-            end
-            break unless response.relations[:next]
-            response = response.relations[:next].call({}, { method: request_method })
-          end
+          data = fetch_with_paginate(path, options, request_settings)
         end
 
         data
@@ -280,7 +265,7 @@ module BookingSync::API
     def middleware
       Faraday::RackBuilder.new do |builder|
         builder.use :logger, logger
-        builder.adapter Faraday.default_adapter
+        builder.adapter :net_http_persistent
       end
     end
 
@@ -362,5 +347,37 @@ module BookingSync::API
         yield payload if block_given?
       end
     end
+
+    def fetch_with_paginate(path, options, request_settings, data = [], response = nil)
+      response = initial_call(path, options, request_settings) unless response
+      data.concat(response.resources)
+      if response.relations[:next] && request_settings[:auto_paginate]
+        fetch_with_paginate(path, options, request_settings, data, next_page(response, request_settings))
+      else
+        data
+      end
+    end
+
+    def fetch_with_block(path, options, request_settings, response = nil, &block)
+      response = initial_call(path, options, request_settings) unless response
+      block.call(response.resources)
+      if response.relations[:next]
+        fetch_with_block(path, options, request_settings, next_page(response, request_settings), &block)
+      end
+    end
+
+    def initial_call(path, options, request_settings)
+      request_method = request_settings[:request_method]
+      if request_method == :get
+        response = call(request_method, path, query: options)
+      else
+        response = call(request_method, path, options)
+      end
+      @pagination_first_response = response
+    end
+
+    def next_page(response, request_settings)
+      response.relations[:next].call({}, { method: request_settings[:request_method] })
+    end
   end
 end

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

@@ -35,7 +35,7 @@ module BookingSync::API
       # @param options [Hash] payment attributes
       # @return [BookingSync::API::Resource] Newly created payment
       def create_payment(booking_id, options = {})
-        post(:payments, booking_id: booking_id, payments: [options]).pop
+        post("bookings/#{booking_id}/payments", payments: [options]).pop
       end
 
       # Edit a payment

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

@@ -40,8 +40,8 @@ module BookingSync::API
       # @param rental [BookingSync::API::Resource|Integer] Rental or ID
       #   of the rental.
       # @return [BookingSync::API::Resource]
-      def rental(rental)
-        get("rentals/#{rental}").pop
+      def rental(rental, options = {})
+        get("rentals/#{rental}", options).pop
       end
 
       # Create a new rental

data/lib/bookingsync/api/version.rb

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

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

@@ -3,6 +3,8 @@ require "spec_helper"
 describe BookingSync::API::Client::Accounts do
   let(:client) { BookingSync::API::Client.new(test_access_token) }
 
+  before { |ex| @casette_base_path = casette_path(casette_dir, ex.metadata) }
+
   describe ".accounts", :vcr do
     it "returns accounts" do
       expect(client.accounts).not_to be_empty
@@ -11,9 +13,13 @@ describe BookingSync::API::Client::Accounts do
   end
 
   describe ".account", :vcr do
+    let(:prefetched_account_id) {
+      find_resource("#{@casette_base_path}_accounts/returns_accounts.yml", "accounts")[:id]
+    }
+
     it "returns a single account" do
-      account = client.account(3837)
-      expect(account.id).to eq 3837
+      account = client.account(prefetched_account_id)
+      expect(account.id).to eq prefetched_account_id
     end
   end
 end

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

@@ -3,6 +3,8 @@ require "spec_helper"
 describe BookingSync::API::Client::Amenities do
   let(:client) { BookingSync::API::Client.new(test_access_token) }
 
+  before { |ex| @casette_base_path = casette_path(casette_dir, ex.metadata) }
+
   describe ".amenities", :vcr do
     it "returns amenities" do
       expect(client.amenities).not_to be_empty
@@ -11,9 +13,13 @@ describe BookingSync::API::Client::Amenities do
   end
 
   describe ".amenity", :vcr do
+    let(:prefetched_amenity) {
+      find_resource("#{@casette_base_path}_amenities/returns_amenities.yml", "amenities")
+    }
+
     it "returns amenity" do
-      amenity = client.amenity(2)
-      expect(amenity.title).to eql("tv")
+      amenity = client.amenity(prefetched_amenity[:id])
+      expect(amenity.title).to eq(prefetched_amenity[:title])
     end
   end
 end

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

@@ -3,6 +3,8 @@ require "spec_helper"
 describe BookingSync::API::Client::Availabilities do
   let(:client) { BookingSync::API::Client.new(test_access_token) }
 
+  before { |ex| @casette_base_path = casette_path(casette_dir, ex.metadata) }
+
   describe ".availabilities", :vcr do
     it "returns availabilities" do
       expect(client.availabilities).not_to be_empty
@@ -11,9 +13,13 @@ describe BookingSync::API::Client::Availabilities do
   end
 
   describe ".availability", :vcr do
+    let(:prefetched_availability_id) {
+      find_resource("#{@casette_base_path}_availabilities/returns_availabilities.yml", "availabilities")[:id]
+    }
+
     it "returns a single availability" do
-      availability = client.availability(2)
-      expect(availability.id).to eq 2
+      availability = client.availability(prefetched_availability_id)
+      expect(availability.id).to eq prefetched_availability_id
     end
   end
 end

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

@@ -3,6 +3,8 @@ require "spec_helper"
 describe BookingSync::API::Client::Bathrooms do
   let(:client) { BookingSync::API::Client.new(test_access_token) }
 
+  before { |ex| @casette_base_path = casette_path(casette_dir, ex.metadata) }
+
   describe ".bathrooms", :vcr do
     it "returns bathrooms" do
       expect(client.bathrooms).not_to be_empty
@@ -11,9 +13,13 @@ describe BookingSync::API::Client::Bathrooms do
   end
 
   describe ".bathroom", :vcr do
+    let(:prefetched_bathroom_id) {
+      find_resource("#{@casette_base_path}_bathrooms/returns_bathrooms.yml", "bathrooms")[:id]
+    }
+
     it "returns a single bathroom" do
-      bathroom = client.bathroom(730)
-      expect(bathroom.id).to eq 730
+      bathroom = client.bathroom(prefetched_bathroom_id)
+      expect(bathroom.id).to eq prefetched_bathroom_id
     end
   end
 
@@ -21,40 +27,43 @@ describe BookingSync::API::Client::Bathrooms do
     let(:attributes) do
       {
         name_en: "New bathroom",
-        wc: true
+        wc_count: 2
       }
     end
     let(:rental) { BookingSync::API::Resource.new(client, id: 5116) }
 
     it "creates a new bathroom" do
       client.create_bathroom(rental, attributes)
-      assert_requested :post, bs_url("rentals/5116/bathrooms"),
+      assert_requested :post, bs_url("rentals/#{rental}/bathrooms"),
         body: { bathrooms: [attributes] }.to_json
     end
 
     it "returns newly created bathroom" do
       VCR.use_cassette("BookingSync_API_Client_Bathrooms/_create_bathroom/creates_a_new_bathroom") do
         bathroom = client.create_bathroom(rental, attributes)
-        expect(bathroom.name).to eql(en: "New bathroom")
-        expect(bathroom.wc).to eql(attributes[:wc])
+        expect(bathroom.name).to eq(en: "New bathroom")
+        expect(bathroom.wc_count).to eq(attributes[:wc_count])
       end
     end
   end
 
   describe ".edit_bathroom", :vcr do
     let(:attributes) {
-      { name_en: "Updated bathroom" }
+      { name_en: "Updated bathroom", name_fr: "Salle de bain 1" }
+    }
+    let(:created_bathroom_id) {
+      find_resource("#{@casette_base_path}_create_bathroom/creates_a_new_bathroom.yml", "bathrooms")[:id]
     }
 
     it "updates given bathroom by ID" do
-      client.edit_bathroom(729, attributes)
-      assert_requested :put, bs_url("bathrooms/729"),
+      client.edit_bathroom(created_bathroom_id, attributes)
+      assert_requested :put, bs_url("bathrooms/#{created_bathroom_id}"),
         body: { bathrooms: [attributes] }.to_json
     end
 
     it "returns updated bathroom" do
       VCR.use_cassette("BookingSync_API_Client_Bathrooms/_edit_bathroom/updates_given_bathroom_by_ID") do
-        bathroom = client.edit_bathroom(729, attributes)
+        bathroom = client.edit_bathroom(created_bathroom_id, attributes)
         expect(bathroom).to be_kind_of(BookingSync::API::Resource)
         expect(bathroom.name).to eq(en: "Updated bathroom", fr: "Salle de bain 1")
       end
@@ -62,9 +71,13 @@ describe BookingSync::API::Client::Bathrooms do
   end
 
   describe ".cancel_bathroom", :vcr do
+    let(:created_bathroom_id) {
+      find_resource("#{@casette_base_path}_create_bathroom/creates_a_new_bathroom.yml", "bathrooms")[:id]
+    }
+
     it "cancels given bathroom" do
-      client.cancel_bathroom(729)
-      assert_requested :delete, bs_url("bathrooms/729")
+      client.cancel_bathroom(created_bathroom_id)
+      assert_requested :delete, bs_url("bathrooms/#{created_bathroom_id}")
     end
   end
 end

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

@@ -3,6 +3,8 @@ require "spec_helper"
 describe BookingSync::API::Client::Bedrooms do
   let(:client) { BookingSync::API::Client.new(test_access_token) }
 
+  before { |ex| @casette_base_path = casette_path(casette_dir, ex.metadata) }
+
   describe ".bedrooms", :vcr do
     it "returns bedrooms" do
       expect(client.bedrooms).not_to be_empty
@@ -11,9 +13,13 @@ describe BookingSync::API::Client::Bedrooms do
   end
 
   describe ".bedroom", :vcr do
+    let(:prefetched_bedroom_id) {
+      find_resource("#{@casette_base_path}_bedrooms/returns_bedrooms.yml", "bedrooms")[:id]
+    }
+
     it "returns a single bedroom" do
-      bedroom = client.bedroom(945)
-      expect(bedroom.id).to eq 945
+      bedroom = client.bedroom(prefetched_bedroom_id)
+      expect(bedroom.id).to eq prefetched_bedroom_id
     end
   end
 
@@ -28,33 +34,36 @@ describe BookingSync::API::Client::Bedrooms do
 
     it "creates a new bedroom" do
       client.create_bedroom(rental, attributes)
-      assert_requested :post, bs_url("rentals/5116/bedrooms"),
+      assert_requested :post, bs_url("rentals/#{rental}/bedrooms"),
         body: { bedrooms: [attributes] }.to_json
     end
 
     it "returns newly created bedroom" do
       VCR.use_cassette("BookingSync_API_Client_Bedrooms/_create_bedroom/creates_a_new_bedroom") do
         bedroom = client.create_bedroom(rental, attributes)
-        expect(bedroom.name).to eql(en: "New bedroom")
-        expect(bedroom.sofa_beds_count).to eql(attributes[:sofa_beds_count])
+        expect(bedroom.name).to eq(en: "New bedroom")
+        expect(bedroom.sofa_beds_count).to eq(attributes[:sofa_beds_count])
       end
     end
   end
 
   describe ".edit_bedroom", :vcr do
     let(:attributes) {
-      { name_en: "Updated bedroom" }
+      { name_en: "Updated bedroom", name_fr: "Chambre 1" }
+    }
+    let(:created_bedroom_id) {
+      find_resource("#{@casette_base_path}_create_bedroom/creates_a_new_bedroom.yml", "bedrooms")[:id]
     }
 
     it "updates given bedroom by ID" do
-      client.edit_bedroom(944, attributes)
-      assert_requested :put, bs_url("bedrooms/944"),
+      client.edit_bedroom(created_bedroom_id, attributes)
+      assert_requested :put, bs_url("bedrooms/#{created_bedroom_id}"),
         body: { bedrooms: [attributes] }.to_json
     end
 
     it "returns updated bedroom" do
       VCR.use_cassette("BookingSync_API_Client_Bedrooms/_edit_bedroom/updates_given_bedroom_by_ID") do
-        bedroom = client.edit_bedroom(944, attributes)
+        bedroom = client.edit_bedroom(created_bedroom_id, attributes)
         expect(bedroom).to be_kind_of(BookingSync::API::Resource)
         expect(bedroom.name).to eq(en: "Updated bedroom", fr: "Chambre 1")
       end
@@ -62,9 +71,13 @@ describe BookingSync::API::Client::Bedrooms do
   end
 
   describe ".cancel_bedroom", :vcr do
+    let(:created_bedroom_id) {
+      find_resource("#{@casette_base_path}_create_bedroom/creates_a_new_bedroom.yml", "bedrooms")[:id]
+    }
+
     it "cancels given bedroom" do
-      client.cancel_bedroom(944)
-      assert_requested :delete, bs_url("bedrooms/944")
+      client.cancel_bedroom(created_bedroom_id)
+      assert_requested :delete, bs_url("bedrooms/#{created_bedroom_id}")
     end
   end
 end

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

@@ -3,6 +3,8 @@ require "spec_helper"
 describe BookingSync::API::Client::BookingComments do
   let(:client) { BookingSync::API::Client.new(test_access_token) }
 
+  before { |ex| @casette_base_path = casette_path(casette_dir, ex.metadata) }
+
   describe ".booking_comments", :vcr do
     it "returns booking_comments" do
       expect(client.booking_comments).not_to be_empty
@@ -11,20 +13,24 @@ describe BookingSync::API::Client::BookingComments do
   end
 
   describe ".booking_comment", :vcr do
+    let(:prefetched_booking_comment_id) {
+      find_resource("#{@casette_base_path}_booking_comments/returns_booking_comments.yml", "booking_comments")[:id]
+    }
+
     it "returns single booking_comment" do
-      booking_comment = client.booking_comment(4)
-      expect(booking_comment.id).to eq(4)
+      booking_comment = client.booking_comment(prefetched_booking_comment_id)
+      expect(booking_comment.id).to eq(prefetched_booking_comment_id)
     end
   end
 
   describe ".create_booking_comment", :vcr do
-    let(:attributes) { { content: "Example conent" } }
-    let(:booking) { BookingSync::API::Resource.new(client, id: 1) }
+    let(:attributes) { { content: "Example content" } }
+    let(:booking) { BookingSync::API::Resource.new(client, id: 817604) }
 
     it "creates booking_comment" do
       client.create_booking_comment(booking.id, attributes)
       assert_requested :post, bs_url("booking_comments"),
-        body: { booking_id: 1, booking_comments: [attributes] }.to_json
+        body: { booking_id: booking.id, booking_comments: [attributes] }.to_json
     end
 
     it "returns newly created booking_comment" do
@@ -35,23 +41,30 @@ describe BookingSync::API::Client::BookingComments do
 
   describe ".edit_booking_comment", :vcr do
     let(:attributes) { { content: "Updated content" } }
+    let(:created_booking_comment_id) {
+      find_resource("#{@casette_base_path}_create_booking_comment/creates_booking_comment.yml", "booking_comments")[:id]
+    }
 
     it "updates booking_comment" do
-      client.edit_booking_comment(9, attributes)
-      assert_requested :put, bs_url("booking_comments/9"),
+      client.edit_booking_comment(created_booking_comment_id, attributes)
+      assert_requested :put, bs_url("booking_comments/#{created_booking_comment_id}"),
         body: { booking_comments: [attributes] }.to_json
     end
 
     it "returns updated booking_comment" do
-      booking_comment = client.edit_booking_comment(9, attributes)
+      booking_comment = client.edit_booking_comment(created_booking_comment_id, attributes)
       expect(booking_comment.content).to eq(attributes[:content])
     end
   end
 
   describe ".delete_booking_comment", :vcr do
+    let(:created_booking_comment_id) {
+      find_resource("#{@casette_base_path}_create_booking_comment/creates_booking_comment.yml", "booking_comments")[:id]
+    }
+
     it "deletes given booking_comment" do
-      client.delete_booking_comment(10)
-      assert_requested :delete, bs_url("booking_comments/10")
+      client.delete_booking_comment(created_booking_comment_id)
+      assert_requested :delete, bs_url("booking_comments/#{created_booking_comment_id}")
     end
   end
 end