bookingsync-api 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0c8ad27849fc4a96f22ac1e26e6131969bb807ac
-  data.tar.gz: 03cf348e183c9ba3cbfbec510f52cc68238ed399
+SHA256:
+  metadata.gz: 5a09e07498321ef580ddd8236abc2981e51f1292ffe3816fd888247a4ce01d34
+  data.tar.gz: 8d5794b071cdb51115431a1598e5635ce8cde59fb11abe7ac564cf1f08700951
 SHA512:
-  metadata.gz: 6d46384ec6e886b7c3f2a4643b21290a294790097c6233c71e4b350a81ef6984934e2de9afc74a37df0da57e70b83c55682bac43c29d701a17b2ac0aa4a9fc3f
-  data.tar.gz: ef07295629c94241a06b2ea350a62a23aaaa20595822d3cfb740d118bc10982777b9a011ece6ace4750c822b966a44c24b493ecee551043bc50c4689da878909
+  metadata.gz: 42b832673aea07e5cf57c2a50ec5982f4f0972e05a8f2c7f5eeedba239eeb5e840ae2672b13bdbbd6528ab582a5b733e626b349c54f550c4fc98443aa50fefa3
+  data.tar.gz: 293aba124873f3f84bb6417ef9dc271e0efc1e2d64bbbf3e9865ed6101901432ad1bfd2a02df76d12153ef3ba17fead418d479bf40077d6f67514fc33c19558e

data/.gitignore

@@ -1,6 +1,7 @@
 *.gem
 *.rbc
 .bundle
+.byebug_history
 .config
 .yardoc
 Gemfile.lock

data/.travis.yml

@@ -2,8 +2,10 @@ language: ruby
 rvm:
   - "2.1"
   - "2.2"
+  - "2.4.4"
+  - "2.5.1"
 before_install:
   - gem install bundler -v 1.12.5
 script:
-  - bundle exec rake style:rubocop:without_auto_correct 
+  - bundle exec rake style:rubocop:without_auto_correct
   - bundle exec rake spec

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 # master
 
+## 0.1.13 - 2019-10-08
+- Add supports for `contacts` endpoint.
+
 ## 0.1.12 - 2018-05-25
 - updated Faraday and Net HTTP Persistent gem to remove workaround
 

data/lib/bookingsync/api/client.rb

@@ -1,6 +1,8 @@
 require "bookingsync/api/middleware/logger"
 require "bookingsync/api/client/accounts"
 require "bookingsync/api/client/amenities"
+require "bookingsync/api/client/applications"
+require "bookingsync/api/client/applications_periods_rentals"
 require "bookingsync/api/client/attachments"
 require "bookingsync/api/client/availabilities"
 require "bookingsync/api/client/bathrooms"
@@ -13,6 +15,7 @@ require "bookingsync/api/client/bookings_tags"
 require "bookingsync/api/client/bookings_taxes"
 require "bookingsync/api/client/change_overs"
 require "bookingsync/api/client/clients"
+require "bookingsync/api/client/contacts"
 require "bookingsync/api/client/destinations"
 require "bookingsync/api/client/fees"
 require "bookingsync/api/client/hosts"
@@ -56,6 +59,8 @@ module BookingSync::API
     extend Forwardable
     include BookingSync::API::Client::Accounts
     include BookingSync::API::Client::Amenities
+    include BookingSync::API::Client::Applications
+    include BookingSync::API::Client::ApplicationsPeriodsRentals
     include BookingSync::API::Client::Attachments
     include BookingSync::API::Client::Availabilities
     include BookingSync::API::Client::Bathrooms
@@ -69,6 +74,7 @@ module BookingSync::API
     include BookingSync::API::Client::ChangeOvers
     include BookingSync::API::Client::Conversations
     include BookingSync::API::Client::Clients
+    include BookingSync::API::Client::Contacts
     include BookingSync::API::Client::Destinations
     include BookingSync::API::Client::Fees
     include BookingSync::API::Client::Hosts
@@ -415,5 +421,9 @@ module BookingSync::API
     def next_page(response, request_settings)
       response.relations[:next].call({}, { method: request_settings[:request_method] })
     end
+
+    def reject_blank_values(array)
+      array.reject { |value| value.nil? || value == "" }
+    end
   end
 end

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

@@ -0,0 +1,43 @@
+module BookingSync::API
+  class Client
+    module Applications
+      # List applications
+      #
+      # Returns all applications supported in BookingSync.
+      # @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 applications.
+      #
+      # @example Get the list of applications for the current account
+      #   applications = @api.applications
+      #   applications.first.title # => "Internet"
+      # @see http://developers.bookingsync.com/reference/endpoints/applications/#list-applications
+      def applications(options = {}, &block)
+        paginate :applications, options, &block
+      end
+
+      # Get a single application
+      #
+      # @param application [BookingSync::API::Resource|Integer] application or ID
+      #   of the application.
+      # @return [BookingSync::API::Resource]
+      # @see http://developers.bookingsync.com/reference/endpoints/applications/#get-a-single-application
+      def application(application)
+        get("applications/#{application}").pop
+      end
+
+      # Edit an application
+      #
+      # @param application [BookingSync::API::Resource|Integer] application or ID of the application
+      # to be updated
+      # @param options [Hash] application attributes to be updated
+      # @return [BookingSync::API::Resource] Updated application on success, exception is raised otherwise
+      # @example
+      #   application = @api.applications.first
+      #   @api.edit_application(application, { default_price_increase: 3 })
+      def edit_application(application, options = {})
+        put("applications/#{application}", applications: [options]).pop
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module BookingSync::API
+  class Client
+    module ApplicationsPeriodsRentals
+      # List applications_periods_rentals
+      #
+      # Returns all applications_periods_rentals supported in BookingSync.
+      # @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 applications_periods_rentals.
+      #
+      # @example Get the list of applications_periods_rentals for the current account
+      #   applications_periods_rentals = @api.applications_periods_rentals
+      #   applications_periods_rentals.first.title # => "Internet"
+      def applications_periods_rentals(options = {}, &block)
+        paginate :applications_periods_rentals, options, &block
+      end
+
+      # Create a applications_periods_rental
+      #
+      # @param options [Hash] applications_periods_rental attributes.
+      # @return [BookingSync::API::Resource] Newly created applications_periods_rental.
+      def create_applications_periods_rental(options = {})
+        post("applications_periods_rentals", applications_periods_rental: options).pop
+      end
+
+      # Get a single applications_periods_rental
+      #
+      # @param applications_periods_rental [BookingSync::API::Resource|Integer] applications_periods_rental or ID
+      #   of the applications_periods_rental.
+      # @return [BookingSync::API::Resource]
+      def applications_periods_rental(applications_periods_rental)
+        get("applications_periods_rentals/#{applications_periods_rental}").pop
+      end
+
+      # Edit an applications_periods_rental
+      #
+      # @param applications_periods_rental [BookingSync::API::Resource|Integer] applications_periods_rental or ID of the applications_periods_rental
+      # to be updated
+      # @param options [Hash] applications_periods_rental attributes to be updated
+      # @return [BookingSync::API::Resource] Updated applications_periods_rental on success, exception is raised otherwise
+      # @example
+      #   applications_periods_rental = @api.applications_periods_rentals.first
+      #   @api.edit_application(applications_periods_rental, { default_price_increase: 3 })
+      def edit_applications_periods_rental(applications_periods_rental, options = {})
+        put("applications_periods_rentals/#{applications_periods_rental}", applications_periods_rental: options).pop
+      end
+    end
+  end
+end

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

@@ -53,7 +53,7 @@ module BookingSync::API
       #   exception is raised otherwise.
       # @example
       #   booking_comment = @api.booking_comments.first
-      #   @api.edit_booking_comment(8, {conent: "New conent"})
+      #   @api.edit_booking_comment(8, {content: "New content"})
       # => {:links=>{:booking=>1}, :id=>8, :content=>"New content", :editable=>true, :created_at=>2016-04-18 13:31:40 UTC, :updated_at=>2016-04-18 13:46:06 UTC}
       def edit_booking_comment(booking_comment, options = {})
         put("booking_comments/#{booking_comment}", booking_comments: [options]).pop

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

@@ -0,0 +1,63 @@
+module BookingSync::API
+  class Client
+    module Contacts
+      # List contacts
+      #
+      # Returns contacts 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 contacts.
+      #
+      # @example Get the list of contacts for the current account
+      #   contacts = @api.contacts
+      #   contacts.first.fullname # => "John Smith"
+      # @example Get the list of contacts only with fullname and phone for smaller response
+      #   @api.contacts(fields: [:fullname, :phone])
+      # @see http://developers.bookingsync.com/reference/endpoints/contacts/#list-contacts
+      def contacts(options = {}, &block)
+        paginate :contacts, options, &block
+      end
+
+      # Get a single contact
+      #
+      # @param contact [BookingSync::API::Resource|Integer] Contact or ID
+      #   of the contact.
+      # @param options [Hash] A customizable set of query options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [BookingSync::API::Resource]
+      def contact(contact, options = {})
+        get("contacts/#{contact}", options).pop
+      end
+
+      # Create a new contact
+      #
+      # @param options [Hash] Contact attributes
+      # @return [BookingSync::API::Resource] Newly created contact
+      def create_contact(options = {})
+        post(:contacts, contacts: [options]).pop
+      end
+
+      # Edit a contact
+      #
+      # @param contact [BookingSync::API::Resource|Integer] Contact or ID of the contact
+      #   to be updated
+      # @param options [Hash] Contact attributes to be updated
+      # @return [BookingSync::API::Resource] Updated contact on success, exception is raised otherwise
+      # @example
+      #   contact = @api.contacts.first
+      #   @api.edit_contact(contact, { fullname: "Gary Smith" })
+      def edit_contact(contact, options = {})
+        put("contacts/#{contact}", contacts: [options]).pop
+      end
+
+      # Delete a contact
+      #
+      # @param contact [BookingSync::API::Resource|Integer] Contact or ID
+      #   of the contact to be deleted.
+      # @return [NilClass] Returns nil on success.
+      def delete_contact(contact)
+        delete "contacts/#{contact}"
+      end
+    end
+  end
+end

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

@@ -30,7 +30,7 @@ module BookingSync::API
       # villas = @api.rentals_search(rental_type: "villa")
       def rentals_search(options = {}, &block)
         ids = Array(options.delete(:ids))
-        path = ["rentals", ids.join(","), "search"].compact.join("/")
+        path = reject_blank_values(["rentals", ids.join(","), "search"]).join("/")
         defaults = { request_method: :post }
         paginate path, defaults.merge(options), &block
       end
@@ -79,7 +79,8 @@ module BookingSync::API
       # @param rentals [Array] IDs of Rentals, leave empty for all account's rentals
       # @return [BookingSync::API::Resource]
       def rentals_meta(rentals = nil)
-        get(["rentals", Array(rentals).join(","), "meta"].compact.join("/")).pop
+        path = reject_blank_values(["rentals", Array(rentals).join(","), "meta"]).join("/")
+        get(path).pop
       end
     end
   end

data/lib/bookingsync/api/version.rb

@@ -1,5 +1,5 @@
 module BookingSync
   module API
-    VERSION = "0.1.12"
+    VERSION = "0.1.13"
   end
 end

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

@@ -0,0 +1,70 @@
+require "spec_helper"
+
+describe BookingSync::API::Client::ApplicationsPeriodsRentals do
+  let(:client) { BookingSync::API::Client.new(test_access_token) }
+
+  before { |ex| @casette_base_path = casette_path(casette_dir, ex.metadata) }
+
+  describe ".applications_periods_rentals", :vcr do
+    it "returns applications_periods_rentals" do
+      expect(client.applications_periods_rentals).not_to be_empty
+      assert_requested :get, bs_url("applications_periods_rentals")
+    end
+  end
+
+  describe ".applications_periods_rental", :vcr do
+    let(:prefetched_applications_periods_rental) {
+      find_resource("#{@casette_base_path}_applications_periods_rentals/returns_applications_periods_rentals.yml", "applications_periods_rentals")
+    }
+
+    it "returns applications_periods_rental" do
+      applications_periods_rental = client.applications_periods_rental(prefetched_applications_periods_rental[:id])
+      expect(applications_periods_rental.price_increase).to eq(prefetched_applications_periods_rental[:price_increase])
+    end
+  end
+
+  describe ".create_applications_periods_rental", :vcr do
+    let(:attributes) {
+      {
+        rental_id: 1,
+        application_id: 9,
+        start_date: "2017-01-03",
+        end_date: "2017-01-04",
+        price_increase: 15.0
+      }
+    }
+
+    it "creates a applications_periods_rental" do
+      client.create_applications_periods_rental(attributes)
+      assert_requested :post, bs_url("applications_periods_rentals"),
+        body: { applications_periods_rental: attributes }.to_json
+    end
+
+    it "returns newly created applications_periods_rental" do
+      VCR.use_cassette("BookingSync_API_Client_Bookings/_create_applications_periods_rental/creates_an_applications_periods_rental") do
+        applications_periods_rental = client.create_applications_periods_rental(attributes)
+        expect(applications_periods_rental).to be_kind_of(BookingSync::API::Resource)
+        expect(applications_periods_rental.price_increase).to eq(attributes[:price_increase].to_s)
+      end
+    end
+  end
+
+  describe ".edit_applications_periods_rental", :vcr do
+    let(:prefetched_edit_applications_periods_rental) {
+      find_resource("#{@casette_base_path}_applications_periods_rentals/returns_applications_periods_rentals.yml", "applications_periods_rentals")
+    }
+    let(:price_increase) { 3.1 }
+
+    it "updates given applications_periods_rental by ID" do
+      client.edit_applications_periods_rental(prefetched_edit_applications_periods_rental, price_increase: price_increase)
+      assert_requested :put, bs_url("applications_periods_rentals/#{prefetched_edit_applications_periods_rental}"),
+        body: { applications_periods_rental: { price_increase: price_increase } }.to_json
+    end
+
+    it "returns updated applications_periods_rental" do
+      applications_periods_rental = client.edit_applications_periods_rental(prefetched_edit_applications_periods_rental, price_increase: price_increase)
+      expect(applications_periods_rental).to be_kind_of(BookingSync::API::Resource)
+      expect(applications_periods_rental.price_increase).to eq(price_increase.to_s)
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe BookingSync::API::Client::Applications do
+  let(:client) { BookingSync::API::Client.new(test_access_token) }
+
+  before { |ex| @casette_base_path = casette_path(casette_dir, ex.metadata) }
+
+  describe ".applications", :vcr do
+    it "returns applications" do
+      expect(client.applications).not_to be_empty
+      assert_requested :get, bs_url("applications")
+    end
+  end
+
+  describe ".application", :vcr do
+    let(:prefetched_application_id) {
+      find_resource("#{@casette_base_path}_applications/returns_applications.yml", "applications")[:id]
+    }
+
+    it "returns a single application" do
+      application = client.application(prefetched_application_id)
+      expect(application.id).to eq prefetched_application_id
+    end
+  end
+
+  describe ".edit_application", :vcr do
+    let(:prefetched_application_id) {
+      find_resource("#{@casette_base_path}_applications/returns_applications.yml", "applications")[:id]
+    }
+    let(:default_price_increase) { 1.1 }
+
+    it "updates given application by ID" do
+      client.edit_application(prefetched_application_id, default_price_increase: default_price_increase)
+      assert_requested :put, bs_url("applications/#{prefetched_application_id}"),
+        body: { applications: [{ default_price_increase: default_price_increase }] }.to_json
+    end
+
+    it "returns updated application" do
+      application = client.edit_application(prefetched_application_id, default_price_increase: default_price_increase)
+      expect(application).to be_kind_of(BookingSync::API::Resource)
+      expect(application.default_price_increase).to eq(default_price_increase.to_s)
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+require "spec_helper"
+
+describe BookingSync::API::Client::Contacts do
+  let(:api) { BookingSync::API::Client.new(test_access_token) }
+
+  before { |ex| @casette_base_path = casette_path(casette_dir, ex.metadata) }
+
+  describe ".contacts", :vcr do
+    subject(:contacts) { api.contacts }
+    subject(:contacts_by_ids) { api.contacts(ids: contact_ids) }
+    let(:contact_ids) do
+      find_resources("#{@casette_base_path}_contacts/returns_contacts.yml", "contacts").map { |r| r["id"] }[0..1]
+    end
+
+    it "returns contacts" do
+      expect(contacts).not_to be_empty
+      assert_requested :get, bs_url("contacts")
+    end
+
+    it "returns contacts by ids" do
+      expect(contacts_by_ids.size).to eq(1)
+      assert_requested :get, bs_url("contacts/#{contact_ids.join(',')}")
+    end
+  end
+
+  describe ".contact", :vcr do
+    subject(:contact) { api.contact(1) }
+
+    it "returns contact" do
+      expect(contact).not_to be_empty
+      assert_requested :get, bs_url("contacts/1")
+    end
+  end
+
+  describe ".contact", :vcr do
+    subject(:contact) { api.contact(prefetched_contact_id) }
+
+    let(:prefetched_contact_id) {
+      find_resource("#{@casette_base_path}_contacts/returns_contacts.yml", "contacts")[:id]
+    }
+
+    it "returns a single contact" do
+      expect(contact.id).to eq prefetched_contact_id
+    end
+  end
+
+  describe ".create_contact", :vcr do
+    subject(:create_contact) { api.create_contact(attributes) }
+
+    let(:attributes) do
+      {
+        firstname: "John",
+        lastname: "Doe",
+        email: "halldor@example.com",
+        website: "http://www.demo.com",
+        address1: "Demo address",
+        gender: "male",
+        phones: [{ label: "default", number: "123456789" }],
+        country_code: "IS",
+        city: "Reykjavik",
+        zip: "33209",
+        state: "Demo",
+        spoken_languages: [:en]
+      }
+    end
+
+    it "creates a new contact" do
+      create_contact
+      assert_requested :post, bs_url("contacts"),
+        body: { contacts: [attributes] }.to_json
+    end
+
+    it "returns newly created contact" do
+      VCR.use_cassette("BookingSync_API_Client_Contacts/_create_contact/creates_a_new_contact") do
+        contact = create_contact
+        expect(contact.email).to eq "halldor@example.com"
+        expect(contact.fullname).to eq ("John Doe")
+      end
+    end
+  end
+
+  describe ".edit_contact", :vcr do
+    subject(:edit_contact) { api.edit_contact(created_contact_id, firstname: "Knut", lastname: "Eljassen") }
+
+    let(:created_contact_id) {
+      find_resource("#{@casette_base_path}_create_contact/creates_a_new_contact.yml", "contacts")[:id]
+    }
+
+    it "updates given contact by ID" do
+      edit_contact
+      assert_requested :put, bs_url("contacts/#{created_contact_id}"),
+        body: { contacts: [{ firstname: "Knut", lastname: "Eljassen" }] }.to_json
+    end
+
+    it "returns updated contact" do
+      VCR.use_cassette("BookingSync_API_Client_Contacts/_edit_contact/updates_given_contact_by_ID") do
+        contact = edit_contact
+        expect(contact).to be_kind_of(BookingSync::API::Resource)
+        expect(contact.fullname).to eq("Knut Eljassen")
+      end
+    end
+  end
+
+  describe ".delete_contact", :vcr do
+    subject(:delete_contact) { api.delete_contact(created_contact_id) }
+
+    let(:created_contact_id) {
+      find_resource("#{casette_dir}/BookingSync_API_Client_Contacts/_create_contact/creates_a_new_contact.yml", "contacts")[:id]
+    }
+
+    it "deletes given contact" do
+      delete_contact
+      assert_requested :delete, bs_url("contacts/#{created_contact_id}")
+    end
+  end
+end