Class: BookingSync::API::Client

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Accounts, Amenities, Availabilities, Bathrooms, Bedrooms, Bookings, BookingsFees, BookingsPayments, BookingsTaxes, Clients, Destinations, Fees, Inquiries, Payments, Periods, Photos, PreferencesGeneralSettings, PreferencesPayments, Rates, RatesRules, RatesTables, RentalAgreements, RentalCancelationPolicies, RentalCancelationPolicyItems, Rentals, RentalsAmenities, RentalsFees, Reviews, Seasons, Sources, SpecialOffers, StrictBookings, Taxes
Defined in:
lib/bookingsync/api/client.rb,
lib/bookingsync/api/client/fees.rb,
lib/bookingsync/api/client/rates.rb,
lib/bookingsync/api/client/taxes.rb,
lib/bookingsync/api/client/photos.rb,
lib/bookingsync/api/client/clients.rb,
lib/bookingsync/api/client/periods.rb,
lib/bookingsync/api/client/rentals.rb,
lib/bookingsync/api/client/reviews.rb,
lib/bookingsync/api/client/seasons.rb,
lib/bookingsync/api/client/sources.rb,
lib/bookingsync/api/client/accounts.rb,
lib/bookingsync/api/client/bedrooms.rb,
lib/bookingsync/api/client/bookings.rb,
lib/bookingsync/api/client/payments.rb,
lib/bookingsync/api/client/amenities.rb,
lib/bookingsync/api/client/bathrooms.rb,
lib/bookingsync/api/client/inquiries.rb,
lib/bookingsync/api/client/rates_rules.rb,
lib/bookingsync/api/client/destinations.rb,
lib/bookingsync/api/client/rates_tables.rb,
lib/bookingsync/api/client/rentals_fees.rb,
lib/bookingsync/api/client/bookings_fees.rb,
lib/bookingsync/api/client/availabilities.rb,
lib/bookingsync/api/client/bookings_taxes.rb,
lib/bookingsync/api/client/special_offers.rb,
lib/bookingsync/api/client/strict_bookings.rb,
lib/bookingsync/api/client/bookings_payments.rb,
lib/bookingsync/api/client/rental_agreements.rb,
lib/bookingsync/api/client/rentals_amenities.rb,
lib/bookingsync/api/client/preferences_payments.rb,
lib/bookingsync/api/client/rental_cancelation_policies.rb,
lib/bookingsync/api/client/preferences_general_settings.rb,
lib/bookingsync/api/client/rental_cancelation_policy_items.rb

Defined Under Namespace

Modules: Accounts, Amenities, Availabilities, Bathrooms, Bedrooms, Bookings, BookingsFees, BookingsPayments, BookingsTaxes, Clients, Destinations, Fees, Inquiries, NoopInstrumenter, Payments, Periods, Photos, PreferencesGeneralSettings, PreferencesPayments, Rates, RatesRules, RatesTables, RentalAgreements, RentalCancelationPolicies, RentalCancelationPolicyItems, Rentals, RentalsAmenities, RentalsFees, Reviews, Seasons, Sources, SpecialOffers, StrictBookings, Taxes

Constant Summary collapse

MEDIA_TYPE = 
"application/vnd.api+json"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Taxes

#tax, #taxes

Methods included from Sources

#create_source, #edit_source, #source, #sources

Methods included from SpecialOffers

#create_special_offer, #delete_special_offer, #edit_special_offer, #special_offer, #special_offers

Methods included from Seasons

#create_season, #delete_season, #edit_season, #season, #seasons

Methods included from Reviews

#create_review, #review, #reviews

Methods included from RentalCancelationPolicyItems

#rental_cancelation_policy_item, #rental_cancelation_policy_items

Methods included from RentalCancelationPolicies

#rental_cancelation_policies, #rental_cancelation_policy

Methods included from RentalAgreements

#create_rental_agreement, #create_rental_agreement_for_booking, #create_rental_agreement_for_rental, #rental_agreement, #rental_agreements

Methods included from RentalsAmenities

#create_rentals_amenity, #delete_rentals_amenity, #edit_rentals_amenity, #rentals_amenities, #rentals_amenity

Methods included from RentalsFees

#create_rentals_fee, #rentals_fee, #rentals_fees

Methods included from Rentals

#create_rental, #delete_rental, #edit_rental, #rental, #rentals, #rentals_meta, #rentals_search

Methods included from RatesTables

#create_rates_table, #delete_rates_table, #edit_rates_table, #rates_table, #rates_tables

Methods included from RatesRules

#create_rates_rule, #delete_rates_rule, #edit_rates_rule, #rates_rule, #rates_rules

Methods included from Rates

#rate, #rates

Methods included from Photos

#create_photo, #delete_photo, #edit_photo, #photo, #photos

Methods included from PreferencesPayments

#preferences_payments

Methods included from PreferencesGeneralSettings

#edit_preferences_general_setting, #preferences_general_settings

Methods included from Payments

#cancel_payment, #create_payment, #edit_payment, #payment, #payments

Methods included from Periods

#create_period, #delete_period, #edit_period, #period, #periods

Methods included from StrictBookings

#create_strict_booking

Methods included from Inquiries

#create_inquiry, #inquiries, #inquiry

Methods included from Fees

#create_fee, #fee, #fees

Methods included from Destinations

#destination, #destinations

Methods included from Clients

#client, #clients, #create_client, #edit_client

Methods included from BookingsTaxes

#bookings_tax, #bookings_taxes

Methods included from BookingsPayments

#bookings_payment, #bookings_payments

Methods included from BookingsFees

#bookings_fee, #bookings_fees

Methods included from Bookings

#booking, #bookings, #cancel_booking, #create_booking, #edit_booking

Methods included from Bedrooms

#bedroom, #bedrooms, #cancel_bedroom, #create_bedroom, #edit_bedroom

Methods included from Bathrooms

#bathroom, #bathrooms, #cancel_bathroom, #create_bathroom, #edit_bathroom

Methods included from Availabilities

#availabilities, #availability

Methods included from Amenities

#amenities, #amenity

Methods included from Accounts

#account, #accounts

Constructor Details

#initialize(token, options = {}) {|@conn| ... } ⇒ BookingSync::API::Client

Initialize new Client

Parameters:

  • token (String) —

    OAuth token

  • options (Hash) (defaults to: {})

Options Hash (options):

  • base_url: (String) —

    Base URL to BookingSync site

  • logger: (Logger) —

    Logger where headers and body of every request and response will be logged.

  • instrumenter: (Module) —

    A module that responds to instrument, usually ActiveSupport::Notifications.

Yields:

  • (@conn) 


96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/bookingsync/api/client.rb', line 96

def initialize(token, options = {})
  @token = token
  @logger = options[:logger] || default_logger
  @instrumenter = options[:instrumenter] || NoopInstrumenter
  @base_url = options[:base_url]
  @serializer = Serializer.new
  @conn = Faraday.new(faraday_options)
  @conn.headers[:accept] = MEDIA_TYPE
  @conn.headers[:content_type] = MEDIA_TYPE
  @conn.headers[:user_agent] = user_agent
  @conn.url_prefix = api_endpoint
  yield @conn if block_given?
end

Instance Attribute Details

#last_response ⇒ Object (readonly)

Returns the value of attribute last_response.



82
83
84
 
# File 'lib/bookingsync/api/client.rb', line 82

def last_response
  @last_response
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



82
83
84
 
# File 'lib/bookingsync/api/client.rb', line 82

def logger
  @logger
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



82
83
84
 
# File 'lib/bookingsync/api/client.rb', line 82

def token
  @token
end

Instance Method Details

#api_endpoint ⇒ String

Return API endpoint

Returns:

  • (String) —

    URL to API endpoint



149
150
151
 
# File 'lib/bookingsync/api/client.rb', line 149

def api_endpoint
  URI.join(base_url, "api/v3").to_s
end

#call(method, path, data = nil, options = nil) ⇒ BookingSync::API::Response

Make a HTTP request to given path and returns Response object.

Parameters:

  • method (Symbol) —

    HTTP verb to use.

  • path (String) —

    The path, relative to #api_endpoint.

  • data (Hash) (defaults to: nil) —

    Data to be send in the request’s body it can include query: key with requests params for GET requests

  • options (Hash) (defaults to: nil) —

    A customizable set of request options.

Returns:



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/bookingsync/api/client.rb', line 226

def call(method, path, data = nil, options = nil)
  instrument("call.bookingsync_api", method: method, path: path) do
    if [:get, :head].include?(method)
      options = data
      data = nil
    end
    options ||= {}
    options[:headers] ||= {}
    options[:headers]["Authorization"] = "Bearer #{token}"

    if options.has_key?(:query)
      if options[:query].has_key?(:ids)
        ids = Array(options[:query].delete(:ids)).join(',')
        path = "#{path}/#{ids}"
      end
      options[:query].keys.each do |key|
        if options[:query][key].is_a?(Array)
          options[:query][key] = options[:query][key].join(",")
        end
      end
    end

    url = expand_url(path, options[:uri])
    res = @conn.send(method, url) do |req|
      if data
        req.body = data.is_a?(String) ? data : encode_body(data)
      end
      if params = options[:query]
        req.params.update params
      end
      req.headers.update options[:headers]
    end
    handle_response(res)
  end
end

#decode_body(str) ⇒ Object

Decode a String response body to a Resource.

Parameters:

  • str (String) —

    The String body from the response.

Returns:

  • (Object) —

    Object resource



165
166
167
 
# File 'lib/bookingsync/api/client.rb', line 165

def decode_body(str)
  @serializer.decode(str)
end

#delete(path, options = {}) ⇒ Array<BookingSync::API::Resource>

Make a HTTP DELETE request

Parameters:

  • path (String) —

    The path, relative to #api_endpoint

  • options (Hash) (defaults to: {}) —

    Body params for the request

Returns:



142
143
144
 
# File 'lib/bookingsync/api/client.rb', line 142

def delete(path, options = {})
  request :delete, path, options
end

#encode_body(data) ⇒ String

Encode an object to a string for the API request.

Parameters:

  • data (Object) —

    The Hash or Resource that is being sent.

Returns:

  • (String) —

    Object encoded into JSON string



157
158
159
 
# File 'lib/bookingsync/api/client.rb', line 157

def encode_body(data)
  @serializer.encode(data)
end

#get(path, options = {}) ⇒ Array<BookingSync::API::Resource>

Make a HTTP GET request

Parameters:

  • path (String) —

    The path, relative to #api_endpoint

  • options (Hash) (defaults to: {}) —

    Query params for the request

Returns:



115
116
117
 
# File 'lib/bookingsync/api/client.rb', line 115

def get(path, options = {})
  request :get, path, query: options
end

#paginate(path, options = {}, &block) ⇒ Array<BookingSync::API::Resource>

Make a HTTP GET request to a path with pagination support.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • per_page: (Integer) —

    Number of resources per page

  • page: (Integer) —

    Number of page to return

  • auto_paginate: (Boolean) —

    If true, all resources will be returned. It makes multiple requestes underneath and joins the results.

Yield Returns:

Returns:



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/bookingsync/api/client.rb', line 194

def paginate(path, options = {}, &block)
  instrument("paginate.bookingsync_api", path: path) do
    auto_paginate = options.delete(:auto_paginate)
    response = call(:get, path, query: options)
    data = response.resources.dup

    if (block_given? or 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].get
      end
    end

    data
  end
end

#post(path, options = {}) ⇒ Array<BookingSync::API::Resource>

Make a HTTP POST request

Parameters:

  • path (String) —

    The path, relative to #api_endpoint

  • options (Hash) (defaults to: {}) —

    Body params for the request

Returns:



124
125
126
 
# File 'lib/bookingsync/api/client.rb', line 124

def post(path, options = {})
  request :post, path, options
end

#put(path, options = {}) ⇒ Array<BookingSync::API::Resource>

Make a HTTP PUT request

Parameters:

  • path (String) —

    The path, relative to #api_endpoint

  • options (Hash) (defaults to: {}) —

    Body params for the request

Returns:



133
134
135
 
# File 'lib/bookingsync/api/client.rb', line 133

def put(path, options = {})
  request :put, path, options
end

#request(method, path, data = nil, options = nil) ⇒ Array<BookingSync::API::Resource>

Make a HTTP request to a path and returns an Array of Resources

Parameters:

  • method (Symbol) —

    HTTP verb to use.

  • path (String) —

    The path, relative to #api_endpoint.

  • data (Hash) (defaults to: nil) —

    Data to be send in the request’s body it can include query: key with requests params for GET requests

  • options (Hash) (defaults to: nil) —

    A customizable set of request options.

Returns:



177
178
179
180
181
182
 
# File 'lib/bookingsync/api/client.rb', line 177

def request(method, path, data = nil, options = nil)
  instrument("request.bookingsync_api", method: method, path: path) do
    response = call(method, path, data, options)
    response.respond_to?(:resources) ? response.resources : response
  end
end