bookingsync-api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04de12efdd7a62fc9a6d1de8f9f164355733e3aa
-  data.tar.gz: 6891716665121a8822573a79018782c38260c9ec
+  metadata.gz: 6915dfa213253a45f23f6ce051ac640ced0823b7
+  data.tar.gz: a799e2b306a6adb73939bab9ea6aa2ab63693a9f
 SHA512:
-  metadata.gz: 2961489c9f1829c1dec6d2dde5570d7033074a3105f28104d4660080906ae2915c1638047a91f71a9c97c3dc499c82540b3e8ed145cc91bea84d6fb6b5514014
-  data.tar.gz: 95d4bd74aaef2f441d0f6154ae77f267c98d05da2a1d3a70e3e8b65a7a131d7924617f569f8e5070f172c2bd467b460488ff4cd5147334bf18cb64d2e929a27e
+  metadata.gz: af88da09b10078bb703df8da722f11cac55cde73df7982400c84d1912642d1726717be0210a235048dc1a1d704d6533eb632daa35ca1d55484d0c2dafa45a084
+  data.tar.gz: 2629e80e6e1461153041c3920d73ac6ae0b8f42eedad7ef4bbbd1645f4014182543e825c3de25c295a03d3af4030de00d1536f1e63e0dad3a5c5d134eb49f0ef

data/.travis.yml

@@ -4,3 +4,6 @@ rvm:
   - "2.2"
 before_install:
   - gem install bundler -v 1.12.5
+script:
+  - bundle exec rake style:rubocop:without_auto_correct 
+  - bundle exec rake spec

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## master
 
+## 0.1.3
+
+- Expose pagination_first_request to easily retrieve right timestamps for updated since syncs.
+- Add support for `living_rooms`.
+
 ## 0.1.2
 
 - Add support for `payment_gateways`.

data/Gemfile

@@ -1,17 +1,17 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in bookingsync-api.gemspec
 
-group 'test' do
-  gem 'rspec'
-  gem 'vcr'
-  gem 'webmock'
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'yard'
-  gem 'ruby_gntp'
-  gem 'pry'
-  gem 'listen', '~> 3.0.0'
+group "test" do
+  gem "rspec"
+  gem "vcr"
+  gem "webmock"
+  gem "guard"
+  gem "guard-rspec"
+  gem "yard"
+  gem "ruby_gntp"
+  gem "pry"
+  gem "listen", "~> 3.0.0"
 end
 
 gemspec

data/Guardfile

@@ -3,5 +3,5 @@ guard :rspec, cmd: "bundle exec rspec --format p" do
   watch(%r{^lib/bookingsync/(.+)\.rb$})             { |m| "spec/bookingsync/#{m[1]}_spec.rb" }
   watch(%r{^lib/bookingsync/api/client/(.+)\.rb$})  { |m| "spec/bookingsync/api/client/#{m[1]}_spec.rb" }
   watch(%r{^lib/bookingsync/api/(.+)\.rb$})         { |m| "spec" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch("spec/spec_helper.rb")  { "spec" }
 end

data/README.md

@@ -67,6 +67,7 @@ access last response.
 ```ruby
 api.rentals(updated_since: "2014-01-01 15:43:96 UTC") # => [BookingSync::API::Resource,    BookingSync::API::Resource, ...]
 api.last_response.meta # => {"deleted_ids" => [1, 3, 4]}
+api.pagination_first_response.meta # => {"deleted_ids" => [1, 3, 4]}
 ```
 
 ### Logging

data/Rakefile

@@ -1,4 +1,14 @@
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-task :default => :spec
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+task default: :spec
 RSpec::Core::RakeTask.new
+
+require "bookingsync/stylecheck"
+load "bookingsync/tasks/stylecheck.rake"

data/bookingsync-api.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'bookingsync/api/version'
+require "bookingsync/api/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "bookingsync-api"
@@ -23,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "addressable"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "bookingsync-stylecheck"
 end

data/lib/bookingsync-api.rb

@@ -1 +1 @@
-require 'bookingsync/api'
+require "bookingsync/api"

data/lib/bookingsync/api/client.rb

@@ -14,6 +14,7 @@ require "bookingsync/api/client/clients"
 require "bookingsync/api/client/destinations"
 require "bookingsync/api/client/fees"
 require "bookingsync/api/client/inquiries"
+require "bookingsync/api/client/living_rooms"
 require "bookingsync/api/client/nightly_rate_maps"
 require "bookingsync/api/client/strict_bookings"
 require "bookingsync/api/client/periods"
@@ -62,6 +63,7 @@ module BookingSync::API
     include BookingSync::API::Client::Destinations
     include BookingSync::API::Client::Fees
     include BookingSync::API::Client::Inquiries
+    include BookingSync::API::Client::LivingRooms
     include BookingSync::API::Client::NightlyRateMaps
     include BookingSync::API::Client::StrictBookings
     include BookingSync::API::Client::Periods
@@ -87,7 +89,7 @@ module BookingSync::API
 
     MEDIA_TYPE = "application/vnd.api+json"
 
-    attr_reader :token, :logger, :last_response
+    attr_reader :token, :logger, :pagination_first_response, :last_response
 
     def_delegator :@instrumenter, :instrument
 
@@ -208,9 +210,10 @@ module BookingSync::API
         else
           response = call(request_method, path, options)
         end
+        @pagination_first_response = response
         data = response.resources.dup
 
-        if (block_given? or auto_paginate) && response.relations[:next]
+        if (block_given? || auto_paginate) && response.relations[:next]
           first_request = true
           loop do
             if block_given?
@@ -220,7 +223,7 @@ module BookingSync::API
               first_request = false
             end
             break unless response.relations[:next]
-            response = response.relations[:next].call({}, method: request_method)
+            response = response.relations[:next].call({}, { method: request_method })
           end
         end
 
@@ -248,7 +251,7 @@ module BookingSync::API
 
         if options.has_key?(:query)
           if options[:query].has_key?(:ids)
-            ids = Array(options[:query].delete(:ids)).join(',')
+            ids = Array(options[:query].delete(:ids)).join(",")
             path = "#{path}/#{ids}"
           end
           options[:query].keys.each do |key|

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

@@ -41,7 +41,7 @@ module BookingSync::API
       # @api.create_booking_comment(1, content: "Hello!")
       # => {:links=>{:booking=>1}, :id=>8, :content=>"Hello!", :editable=>true, :created_at=>2016-04-18 13:31:40 UTC, :updated_at=>2016-04-18 13:46:06 UTC}
       def create_booking_comment(booking, options = {})
-        post("booking_comments", { booking_id: booking, booking_comments: [options] }).pop
+        post("booking_comments", booking_id: booking, booking_comments: [options]).pop
       end
 
       # Edit a booking_comment

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

@@ -0,0 +1,65 @@
+module BookingSync::API
+  class Client
+    module LivingRooms
+      # List living_rooms
+      #
+      # Returns living_rooms 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 living_rooms.
+      #
+      # @example Get the list of living_rooms for the current account
+      #   living_rooms = @api.living_rooms
+      #   living_rooms.first.bunk_beds_count # => 2
+      # @example Get the list of living_rooms only with bunk_beds_count for smaller response
+      #   @api.living_rooms(fields: [:bunk_beds_count])
+      def living_rooms(options = {}, &block)
+        paginate :living_rooms, options, &block
+      end
+
+      # Get a single living_room
+      #
+      # @param living_room [BookingSync::API::Resource|Integer] LivingRoom or ID
+      #   of the living_room.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def living_room(living_room, options = {})
+        get("living_rooms/#{living_room}", options).pop
+      end
+
+      # Create a new living_room
+      #
+      # @param rental [BookingSync::API::Resource|Integer] Rental or ID of
+      #   the rental for which living_room will be created.
+      # @param options [Hash] LivingRoom's attributes.
+      # @return [BookingSync::API::Resource] Newly created living_room.
+      def create_living_room(rental, options = {})
+        post("rentals/#{rental}/living_rooms", living_rooms: [options]).pop
+      end
+
+      # Edit a living_room
+      #
+      # @param living_room [BookingSync::API::Resource|Integer] LivingRoom or ID of
+      #   the living_room to be updated.
+      # @param options [Hash] LivingRoom attributes to be updated.
+      # @return [BookingSync::API::Resource] Updated living_room on success,
+      #   exception is raised otherwise.
+      # @example
+      #   living_room = @api.living_rooms.first
+      #   @api.edit_living_room(living_room, { bunk_beds_count: 3 })
+      def edit_living_room(living_room, options = {})
+        put("living_rooms/#{living_room}", living_rooms: [options]).pop
+      end
+
+      # Cancel a living_room
+      #
+      # @param living_room [BookingSync::API::Resource|Integer] LivingRoom or ID
+      #   of the living_room to be canceled.
+      # @return [NilClass] Returns nil on success.
+      def cancel_living_room(living_room)
+        delete "living_rooms/#{living_room}"
+      end
+    end
+  end
+end

data/lib/bookingsync/api/error.rb

@@ -10,7 +10,7 @@ module BookingSync::API
     end
 
     def message(message = self.class)
-      %Q{#{message}
+      %{#{message}
 HTTP status code : #{status}
 Headers          : #{headers}
 Body             : #{body}}

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

@@ -1,4 +1,4 @@
-require 'forwardable'
+require "forwardable"
 
 module BookingSync::API::Middleware
   # Provides logger for request and responses made by API Client.
@@ -20,13 +20,13 @@ module BookingSync::API::Middleware
 
     def call(env)
       info "Request #{env.method.upcase} #{env.url.to_s}"
-      debug('Request headers') { dump_headers env.request_headers }
-      debug('Request body') { dump_body env.body }
+      debug("Request headers") { dump_headers env.request_headers }
+      debug("Request body") { dump_body env.body }
       @app.call(env).tap do |response|
         info "Response X-Request-Id: #{env.response_headers['X-Request-Id']} #{env.method.upcase} #{env.url.to_s}"
-        debug('Response headers') { dump_headers response.env.response_headers }
-        debug('Response status') { response.env.status }
-        debug('Response body') { dump_body response.env.body }
+        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
 

data/lib/bookingsync/api/resource.rb

@@ -69,7 +69,7 @@ module BookingSync::API
 
     def extract_resources(ids, association_key, uri_association_key, *args)
       return [] if ids.empty?
-      options = {uri: {uri_association_key => ids}}
+      options = { uri: { uri_association_key => ids } }
       options.merge!(query: args.first) if args.first.is_a?(Hash)
       @_rels[association_key].get(options).resources
     end

data/lib/bookingsync/api/response.rb

@@ -76,9 +76,9 @@ module BookingSync::API
     end
 
     def process_rels
-      links = ( @headers["Link"] || "" ).split(', ').map do |link|
+      links = (@headers["Link"] || "").split(", ").map do |link|
         href, name = link.match(/<(.*?)>; rel="(\w+)"/).captures
-        [name.to_sym, Relation.from_link(@client, name, :href => href)]
+        [name.to_sym, Relation.from_link(@client, name, href: href)]
       end
       Hash[*links.flatten]
     end

data/lib/bookingsync/api/serializer.rb

@@ -1,6 +1,6 @@
-require 'date'
-require 'time'
-require 'json'
+require "date"
+require "time"
+require "json"
 
 module BookingSync::API
   class Serializer
@@ -22,7 +22,7 @@ module BookingSync::API
       @dump.call(encode_object(data))
     end
 
-    alias dump encode
+    alias_method :dump, :encode
 
     # Public: Decodes a String into an Object (usually a Hash or Array of
     # Hashes).
@@ -35,7 +35,7 @@ module BookingSync::API
       decode_object(@load.call(data))
     end
 
-    alias load decode
+    alias_method :load, :decode
 
     def encode_object(data)
       case data

data/lib/bookingsync/api/version.rb

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

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

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe BookingSync::API::Client::Bathrooms do
-
   let(:client) { BookingSync::API::Client.new(test_access_token) }
 
   describe ".bathrooms", :vcr do
@@ -19,10 +18,12 @@ describe BookingSync::API::Client::Bathrooms do
   end
 
   describe ".create_bathroom", :vcr do
-    let(:attributes) {{
-      name_en: "New bathroom",
-      wc: true
-    }}
+    let(:attributes) do
+      {
+        name_en: "New bathroom",
+        wc: true
+      }
+    end
     let(:rental) { BookingSync::API::Resource.new(client, id: 5116) }
 
     it "creates a new bathroom" do
@@ -32,9 +33,9 @@ describe BookingSync::API::Client::Bathrooms do
     end
 
     it "returns newly created bathroom" do
-      VCR.use_cassette('BookingSync_API_Client_Bathrooms/_create_bathroom/creates_a_new_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.name).to eql(en: "New bathroom")
         expect(bathroom.wc).to eql(attributes[:wc])
       end
     end
@@ -52,10 +53,10 @@ describe BookingSync::API::Client::Bathrooms do
     end
 
     it "returns updated bathroom" do
-      VCR.use_cassette('BookingSync_API_Client_Bathrooms/_edit_bathroom/updates_given_bathroom_by_ID') do
+      VCR.use_cassette("BookingSync_API_Client_Bathrooms/_edit_bathroom/updates_given_bathroom_by_ID") do
         bathroom = client.edit_bathroom(729, attributes)
         expect(bathroom).to be_kind_of(BookingSync::API::Resource)
-        expect(bathroom.name).to eq({ en: "Updated bathroom", fr: "Salle de bain 1" })
+        expect(bathroom.name).to eq(en: "Updated bathroom", fr: "Salle de bain 1")
       end
     end
   end

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

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe BookingSync::API::Client::Bedrooms do
-
   let(:client) { BookingSync::API::Client.new(test_access_token) }
 
   describe ".bedrooms", :vcr do
@@ -19,10 +18,12 @@ describe BookingSync::API::Client::Bedrooms do
   end
 
   describe ".create_bedroom", :vcr do
-    let(:attributes) {{
-      name_en: "New bedroom",
-      sofa_beds_count: 2
-    }}
+    let(:attributes) do
+      {
+        name_en: "New bedroom",
+        sofa_beds_count: 2
+      }
+    end
     let(:rental) { BookingSync::API::Resource.new(client, id: 5116) }
 
     it "creates a new bedroom" do
@@ -32,9 +33,9 @@ describe BookingSync::API::Client::Bedrooms do
     end
 
     it "returns newly created bedroom" do
-      VCR.use_cassette('BookingSync_API_Client_Bedrooms/_create_bedroom/creates_a_new_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.name).to eql(en: "New bedroom")
         expect(bedroom.sofa_beds_count).to eql(attributes[:sofa_beds_count])
       end
     end
@@ -52,10 +53,10 @@ describe BookingSync::API::Client::Bedrooms do
     end
 
     it "returns updated bedroom" do
-      VCR.use_cassette('BookingSync_API_Client_Bedrooms/_edit_bedroom/updates_given_bedroom_by_ID') do
+      VCR.use_cassette("BookingSync_API_Client_Bedrooms/_edit_bedroom/updates_given_bedroom_by_ID") do
         bedroom = client.edit_bedroom(944, attributes)
         expect(bedroom).to be_kind_of(BookingSync::API::Resource)
-        expect(bedroom.name).to eq({ en: "Updated bedroom", fr: "Chambre 1" })
+        expect(bedroom.name).to eq(en: "Updated bedroom", fr: "Chambre 1")
       end
     end
   end

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

@@ -44,26 +44,26 @@ describe BookingSync::API::Client::Bookings do
     end
 
     it "returns a single canceled booking" do
-      booking = client.booking(114760, { include_canceled: true })
+      booking = client.booking(114760, include_canceled: true)
       expect(booking.status).to eq "Canceled"
     end
   end
 
   describe ".create_booking", :vcr do
     let(:attributes) {
-      {start_at: '2014-01-03', end_at: '2014-01-04',
-        booked: true}
+      { 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(rental, attributes)
       assert_requested :post, bs_url("rentals/20/bookings"),
-        body: {bookings: [attributes]}.to_json
+        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
+      VCR.use_cassette("BookingSync_API_Client_Bookings/_create_booking/creates_a_booking") do
         booking = client.create_booking(rental, attributes)
         expect(booking.account_id).to eql(1)
         expect(booking.rental_id).to eql(20)
@@ -73,25 +73,25 @@ describe BookingSync::API::Client::Bookings do
 
   describe ".edit_booking", :vcr do
     it "updates given booking by ID" do
-      client.edit_booking(50, {end_at: "2019-03-25 21:45:00 UTC"})
+      client.edit_booking(50, end_at: "2019-03-25 21:45:00 UTC")
       assert_requested :put, bs_url("bookings/50"),
-        body: {bookings: [{end_at: "2019-03-25 21:45:00 UTC"}]}.to_json
+        body: { bookings: [{ end_at: "2019-03-25 21:45:00 UTC" }] }.to_json
     end
 
     it "returns updated booking" do
-      VCR.use_cassette('BookingSync_API_Client_Bookings/_edit_booking/updates_given_booking_by_ID') do
-        booking = client.edit_booking(50, {end_at: "2019-03-25 21:45:00 UTC"})
+      VCR.use_cassette("BookingSync_API_Client_Bookings/_edit_booking/updates_given_booking_by_ID") do
+        booking = client.edit_booking(50, end_at: "2019-03-25 21:45:00 UTC")
         expect(booking).to be_kind_of(BookingSync::API::Resource)
         expect(booking.end_at).to eq(Time.parse("2019-03-25 21:45:00 UTC"))
       end
     end
 
     it "updates given booking by Resource object" do
-      VCR.use_cassette('BookingSync_API_Client_Bookings/_edit_booking/updates_given_booking_by_ID') do
-        resource = BookingSync::API::Resource.new(nil, {id: 50})
-        client.edit_booking(resource, {end_at: "2019-03-25 21:45:00 UTC"})
+      VCR.use_cassette("BookingSync_API_Client_Bookings/_edit_booking/updates_given_booking_by_ID") do
+        resource = BookingSync::API::Resource.new(nil, id: 50)
+        client.edit_booking(resource, end_at: "2019-03-25 21:45:00 UTC")
         assert_requested :put, bs_url("bookings/50"),
-          body: {bookings: [{end_at: "2019-03-25 21:45:00 UTC"}]}.to_json
+          body: { bookings: [{ end_at: "2019-03-25 21:45:00 UTC" }] }.to_json
       end
     end
   end