bookingsync-api 0.0.8 → 0.0.9

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

@@ -20,19 +20,21 @@ module BookingSync::API
 
       # Create a new season
       #
-      # @param rates_table_id [Integer] ID of the rates table
-      # @param options [Hash] season attributes
-      # @return [BookingSync::API::Resource] Newly created season
-      def create_season(rates_table_id, options = {})
-        post(:seasons, rates_table_id: rates_table_id, seasons: [options]).pop
+      # @param rates_table_id [BookingSync::API::Resource|Integer] Rates table
+      #   or ID of the rates table for which a season will be created.
+      # @param options [Hash] Season's attributes.
+      # @return [BookingSync::API::Resource] Newly created season.
+      def create_season(rates_table, options = {})
+        post("rates_tables/#{rates_table}/seasons", seasons: [options]).pop
       end
 
       # Edit a season
       #
-      # @param season [BookingSync::API::Resource|Integer] season or ID of the season
-      # to be updated
-      # @param options [Hash] season attributes to be updated
-      # @return [BookingSync::API::Resource] Updated season on success, exception is raised otherwise
+      # @param season [BookingSync::API::Resource|Integer] Season or ID of
+      #   the season to be updated.
+      # @param options [Hash] Season attributes to be updated.
+      # @return [BookingSync::API::Resource] Updated season on success,
+      #   exception is raised otherwise.
       # @example
       #   season = @api.seasons.first
       #   @api.edit_season(season, { name: "Some season" })
@@ -42,10 +44,10 @@ module BookingSync::API
 
       # Delete a season
       #
-      # @param season [BookingSync::API::Resource|Integer] season or ID of the season
-      # to be deleted
-      # @return [Array] An empty Array on success, exception is raised otherwise
-      def delete_season(season, options = {})
+      # @param season [BookingSync::API::Resource|Integer] Season or ID
+      #   of the season to be deleted.
+      # @return [NilClass] Returns nil on success.
+      def delete_season(season)
         delete "seasons/#{season}"
       end
     end

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

@@ -3,7 +3,7 @@ module BookingSync::API
     module SpecialOffers
       # List special_offers
       #
-      # Returns special_offers for the account user is authenticated with.
+      # Returns special offers for the account user is authenticated with.
       # @param options [Hash] A customizable set of options.
       # @option options [Array] fields: List of fields to be fetched.
       # @return [Array<BookingSync::API::Resource>] Array of special_offers.
@@ -18,35 +18,36 @@ module BookingSync::API
         paginate :special_offers, options, &block
       end
 
-      # Create a new special_offer
+      # Create a new special offer for a rental
       #
-      # @param rental_id [Integer] ID of the rental
-      # @param options [Hash] special_offer attributes
-      # @return [BookingSync::API::Resource] Newly created special offer
-      def create_special_offer(rental_id, options = {})
-        post(:special_offers, rental_id: rental_id, special_offers: [options]).pop
+      # @param rental [BookingSync::API::Resource|Integer] Rental or ID of the
+      #   rental for which special offer will be created.
+      # @param options [Hash] Special offer's attributes.
+      # @return [BookingSync::API::Resource] Newly created special offer.
+      def create_special_offer(rental, options = {})
+        post("rentals/#{rental}/special_offers", special_offers: [options]).pop
       end
 
-      # Edit a special_offer
+      # Edit a special offer
       #
-      # @param special_offer [BookingSync::API::Resource|Integer] special offer or
-      # ID of the special offer to be updated
-      # @param options [Hash] special offer attributes to be updated
+      # @param special_offer [BookingSync::API::Resource|Integer] Special offer
+      #   or ID of the special offer to be updated.
+      # @param options [Hash] special offer attributes to be updated.
       # @return [BookingSync::API::Resource] Updated special offer on success,
-      # exception is raised otherwise
+      #   exception is raised otherwise.
       # @example
       #   special_offer = @api.special_offers.first
-      #   @api.edit_special_offer(special_offer, { name: "New offer" })
+      #   @api.edit_special_offer(special_offer, {name: "New offer"})
       def edit_special_offer(special_offer, options = {})
         put("special_offers/#{special_offer}", special_offers: [options]).pop
       end
 
-      # Delete a special_offer
+      # Delete a special offer
       #
-      # @param special_offer [BookingSync::API::Resource|Integer] special offer or
-      # ID of the special offer to be deleted
-      # @return [Array] An empty Array on success, exception is raised otherwise
-      def delete_special_offer(special_offer, options = {})
+      # @param special_offer [BookingSync::API::Resource|Integer] Special offer
+      #   or ID of the special offer to be deleted.
+      # @return [NilClass] Returns nil on success.
+      def delete_special_offer(special_offer)
         delete "special_offers/#{special_offer}"
       end
     end

data/lib/bookingsync/api/error.rb

@@ -3,4 +3,22 @@ module BookingSync::API
   class Error < StandardError; end
   class Unauthorized < Error; end
   class UnprocessableEntity < Error; end
+  class NotFound < Error; end
+
+  class UnsupportedResponse < Error
+    attr_reader :status, :headers, :body
+
+    def initialize(response)
+      @status  = response.status
+      @headers = response.headers
+      @body    = response.body
+    end
+
+    def message
+      %Q{Received unsupported response from BookingSync API
+HTTP status code : #{status}
+Headers          : #{headers}
+Body             : #{body}}
+    end
+  end
 end

data/lib/bookingsync/api/middleware/logger.rb

@@ -0,0 +1,50 @@
+require 'forwardable'
+
+module BookingSync::API::Middleware
+  # Provides logger for request and responses made by API Client.
+  # JSON data is displayed in an eye-friendly format.
+  # User can provide his own logger in BookingSync::API::Client.new
+  #
+  # Log Levels
+  #   INFO - logged are only request method and URL.
+  #   DEBUG - logged are headers and bodies of requests and responses.
+  class Logger < Faraday::Middleware
+    extend Forwardable
+
+    def initialize(app, logger)
+      super(app)
+      @logger = logger
+    end
+
+    def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+
+    def call(env)
+      info "#{env.method.upcase} #{env.url.to_s}"
+      debug('Request headers') { dump_headers env.request_headers }
+      debug('Request body') { dump_body env.body }
+      @app.call(env).tap do |response|
+        debug('Response headers') { dump_headers response.env.response_headers }
+        debug('Response status') { response.env.status }
+        debug('Response body') { dump_body response.env.body }
+      end
+    end
+
+    private
+
+    def dump_body(body)
+      if body && body != ""
+        JSON.pretty_generate(JSON.parse(body))
+      else
+        "No body"
+      end
+    rescue JSON::ParserError
+      "Invalid JSON"
+    end
+
+    def dump_headers(headers)
+      headers.map { |k, v| "#{k}: #{v.inspect}" }.join("\n")
+    end
+  end
+
+  Faraday::Middleware.register_middleware logger: Logger
+end

data/lib/bookingsync/api/version.rb

@@ -1,5 +1,5 @@
 module BookingSync
   module API
-    VERSION = "0.0.8"
+    VERSION = "0.0.9"
   end
 end

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

@@ -39,19 +39,20 @@ describe BookingSync::API::Client::Bookings do
 
   describe ".create_booking", :vcr do
     let(:attributes) {
-      {start_at: '2014-01-03', end_at: '2014-01-04', rental_id: 20,
+      {start_at: '2014-01-03', end_at: '2014-01-04',
         booked: true}
     }
+    let(:rental) { BookingSync::API::Resource.new(client, id: 20) }
 
     it "creates a booking" do
-      client.create_booking(attributes)
-      assert_requested :post, bs_url("bookings"),
+      client.create_booking(rental, attributes)
+      assert_requested :post, bs_url("rentals/20/bookings"),
         body: {bookings: [attributes]}.to_json
     end
 
     it "returns newly created booking" do
       VCR.use_cassette('BookingSync_API_Client_Bookings/_create_booking/creates_a_booking') do
-        booking = client.create_booking(attributes)
+        booking = client.create_booking(rental, attributes)
         expect(booking.account_id).to eql(1)
         expect(booking.rental_id).to eql(20)
       end

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

@@ -19,16 +19,17 @@ describe BookingSync::API::Client::Inquiries do
       lastname:  "Smith",
       email:     "john@example.com"
     } }
+    let(:rental) { BookingSync::API::Resource.new(client, id: 7) }
 
     it "creates a new inquiry" do
-      client.create_inquiry(attributes)
-      assert_requested :post, bs_url("inquiries"),
+      client.create_inquiry(rental, attributes)
+      assert_requested :post, bs_url("rentals/7/inquiries"),
         body: {inquiries: [attributes]}.to_json
     end
 
     it "returns newly created inquiry" do
       VCR.use_cassette('BookingSync_API_Client_Inquiries/_create_inquiry/creates_a_new_inquiry') do
-        inquiry = client.create_inquiry(attributes)
+        inquiry = client.create_inquiry(rental, attributes)
         expect(inquiry.rental_id).to eql(7)
         expect(inquiry.firstname).to eql("John")
       end

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

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe BookingSync::API::Client::Periods do
-
   let(:client) { BookingSync::API::Client.new(test_access_token) }
 
   describe ".periods", :vcr do
@@ -12,20 +11,18 @@ describe BookingSync::API::Client::Periods do
   end
 
   describe ".create_period", :vcr do
-    let(:attributes) { {
-      start_at: "2013-04-10",
-      end_at: "2013-04-22"
-    } }
+    let(:attributes) { {start_at: "2013-04-10", end_at: "2013-04-22"} }
+    let(:season) { BookingSync::API::Resource.new(client, id: 9) }
 
     it "creates a new period" do
-      client.create_period(9, attributes)
-      assert_requested :post, bs_url("periods"),
-        body: { season_id: 9, periods: [attributes] }.to_json
+      client.create_period(season, attributes)
+      assert_requested :post, bs_url("seasons/9/periods"),
+        body: {periods: [attributes]}.to_json
     end
 
     it "returns newly created period" do
       VCR.use_cassette('BookingSync_API_Client_Periods/_create_period/creates_a_new_period') do
-        period = client.create_period(9, attributes)
+        period = client.create_period(season, attributes)
         expect(period.start_at).to eql(Time.parse(attributes[:start_at]))
         expect(period.end_at).to eql(Time.parse(attributes[:end_at]))
       end
@@ -33,9 +30,7 @@ describe BookingSync::API::Client::Periods do
   end
 
   describe ".edit_period", :vcr do
-    let(:attributes) {
-      { end_at: '2014-07-15' }
-    }
+    let(:attributes) { {end_at: '2014-07-15'} }
 
     it "updates given period by ID" do
       client.edit_period(6, attributes)
@@ -54,8 +49,8 @@ describe BookingSync::API::Client::Periods do
 
   describe ".delete_period", :vcr do
     it "deletes given period" do
-      client.delete_period(10)
-      assert_requested :delete, bs_url("periods/10")
+      client.delete_period(3)
+      assert_requested :delete, bs_url("periods/3")
     end
   end
 end

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

@@ -2,6 +2,7 @@ require "spec_helper"
 
 describe BookingSync::API::Client::Photos do
   let(:client) { BookingSync::API::Client.new(test_access_token) }
+  let(:rental) { BookingSync::API::Resource.new(client, id: 2) }
 
   describe ".photos", :vcr do
     it "returns photos" do
@@ -9,4 +10,61 @@ describe BookingSync::API::Client::Photos do
       assert_requested :get, bs_url("photos")
     end
   end
+
+  describe ".create_photo", :vcr do
+    let(:attributes) do
+      {photo_path: "spec/fixtures/files/test.jpg",
+        description_en: "Funny", kind: "livingroom"}
+    end
+
+    it "creates a photo with photo path" do
+      photo = client.create_photo(rental, attributes)
+      assert_requested :post, bs_url("rentals/2/photos"),
+        body: {photos: [attributes]}.to_json
+      expect(photo.kind).to eq("livingroom")
+    end
+
+    it "creates a photo with encoded photo file" do
+      encoded = Base64.encode64(File.read("spec/fixtures/files/test.jpg"))
+      photo = client.create_photo(rental, photo: encoded, kind: "livingroom")
+      assert_requested :post, bs_url("rentals/2/photos"),
+        body: {photos: [photo: encoded, kind: "livingroom"]}.to_json
+      expect(photo.kind).to eq("livingroom")
+    end
+
+    it "creates a photo with remote URL" do
+      remote_url = "https://www.ruby-lang.org/images/header-ruby-logo.png"
+      photo = client.create_photo(rental, remote_photo_url: remote_url,
+        kind: "livingroom")
+      assert_requested :post, bs_url("rentals/2/photos"),
+        body: {photos: [remote_photo_url: remote_url, kind: "livingroom"]}.to_json
+      expect(photo.kind).to eq("livingroom")
+    end
+
+    it "returns newly created photo" do
+      VCR.use_cassette('BookingSync_API_Client_Photos/_create_photo/creates_a_photo') do
+        photo = client.create_photo(rental, attributes)
+        expect(photo.kind).to eq("livingroom")
+        expect(photo.description.en).to eq("Funny")
+      end
+    end
+  end
+
+  describe ".edit_photo", :vcr do
+    it "updates photo's description" do
+      photo = client.edit_photo(37, description_en: "Not funny anymore")
+      expect(photo.description.en).to eq("Not funny anymore")
+    end
+
+    it "updates photo's image file" do
+      photo = client.edit_photo(37, file_path: "spec/fixtures/files/test.jpg")
+      expect(photo.description.en).to eq("Not funny anymore")
+    end
+  end
+
+  describe ".delete_photo", :vcr do
+    it "delete given photo" do
+      expect(client.delete_photo(37)).to be_nil
+    end
+  end
 end

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

@@ -29,34 +29,34 @@ describe BookingSync::API::Client::RentalAgreements do
   end
 
   describe ".create_rental_agreement_for_booking", :vcr do
-    let(:booking_id) { 2 }
+    let(:booking) { BookingSync::API::Resource.new(client, id: 2) }
 
     it "creates a new rental agreement" do
-      client.create_rental_agreement_for_booking(booking_id, attributes)
-      assert_requested :post, bs_url("rental_agreements"),
-        body: { booking_id: booking_id, rental_agreements: [attributes] }.to_json
+      client.create_rental_agreement_for_booking(booking, attributes)
+      assert_requested :post, bs_url("bookings/#{booking}/rental_agreements"),
+        body: {rental_agreements: [attributes]}.to_json
     end
 
     it "returns newly created rental agreement" do
       VCR.use_cassette('BookingSync_API_Client_RentalAgreements/_create_rental_agreement_for_booking/creates_a_new_rental_agreement') do
-        rental_agreement = client.create_rental_agreement_for_booking(booking_id, attributes)
+        rental_agreement = client.create_rental_agreement_for_booking(booking, attributes)
         expect(rental_agreement.body).to eql(attributes[:body])
       end
     end
   end
 
   describe ".create_rental_agreement_for_rental", :vcr do
-    let(:rental_id) { 20 }
+    let(:rental) { BookingSync::API::Resource.new(client, id: 20) }
 
     it "creates a new rental agreement" do
-      client.create_rental_agreement_for_rental(rental_id, attributes)
-      assert_requested :post, bs_url("rental_agreements"),
-        body: { rental_id: rental_id, rental_agreements: [attributes] }.to_json
+      client.create_rental_agreement_for_rental(rental, attributes)
+      assert_requested :post, bs_url("rentals/20/rental_agreements"),
+        body: {rental_agreements: [attributes]}.to_json
     end
 
     it "returns newly created rental agreement" do
       VCR.use_cassette('BookingSync_API_Client_RentalAgreements/_create_rental_agreement_for_rental/creates_a_new_rental_agreement') do
-        rental_agreement = client.create_rental_agreement_for_rental(rental_id, attributes)
+        rental_agreement = client.create_rental_agreement_for_rental(rental, attributes)
         expect(rental_agreement.body).to eql(attributes[:body])
       end
     end

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

@@ -61,9 +61,9 @@ describe BookingSync::API::Client::Rentals do
     end
   end
 
-  describe ".cancel_rental", :vcr do
-    it "cancels given rental" do
-      client.cancel_rental(4)
+  describe ".delete_rental", :vcr do
+    it "deletes given rental" do
+      client.delete_rental(4)
       assert_requested :delete, bs_url("rentals/4")
     end
   end

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

@@ -15,16 +15,17 @@ describe BookingSync::API::Client::Reviews do
       comment: "Awesome place",
       rating: 5
     }}
+    let(:booking) { BookingSync::API::Resource.new(client, id: 1) }
 
     it "creates a new review" do
-      client.create_review(1, attributes)
-      assert_requested :post, bs_url("reviews"),
-        body: { booking_id: 1, reviews: [attributes] }.to_json
+      client.create_review(booking, attributes)
+      assert_requested :post, bs_url("bookings/1/reviews"),
+        body: {reviews: [attributes]}.to_json
     end
 
     it "returns newly created review" do
       VCR.use_cassette('BookingSync_API_Client_Reviews/_create_review/creates_a_new_review') do
-        review = client.create_review(1, attributes)
+        review = client.create_review(booking, attributes)
         expect(review.comment).to eql(attributes[:comment])
         expect(review.rating).to eql(attributes[:rating])
       end