bookingsync-api 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 445f23d326e4331163eab11f0156f4571df34382
-  data.tar.gz: 32a2bfa0eaf8902714af8a2dedea2a852cdf35eb
+  metadata.gz: 07875aceb5be5188713572808a3279c3ef1850ee
+  data.tar.gz: 9a346db370e70f7ad358e416a4ad28de91912dc8
 SHA512:
-  metadata.gz: 12fde8daede41304f9a1707dcc609519e9130e8b1d912b7e02753069e551a3628add14970bb3f77a8453f25a9c313b76d39fac0eef31dac8831a15c9c124ecac
-  data.tar.gz: 658aff5e26667bb67f6f629f126a36740c005f93a8e5ff3ff0255d99fa919ea6d2f78f4eb34e6c38507611ea2baa1fb9571c413e12b6f6a5c6447de2d86fb0ae
+  metadata.gz: 42a65dfbf9e155c9589377219aaf54d163f0e39fa96ad5ddd5a2295e60450dbfbdcc43d226e3b3e4204addb30bb0fd659d6e7f4aafb28a67052c4f5e2ec10dc5
+  data.tar.gz: ec176fddc4a0c67f9787e9eef645e5dbc065914ec1e2b31c811edb424131aa009f5221dd0a3e614313f53d40910c0517e3d3c8fef594a7782ae6a3ef555fb082

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+# master
+
+## 0.1.9 - 2018-04-30
+
+- Enable dynamic override of headers per request.
+- Add support for `inbox` endpoints.
+
 ## 0.1.8 - 2017-12-05
 
 - Add support for `bookings_tags` endpoint.

data/README.md

@@ -70,6 +70,19 @@ api.last_response.meta # => {"deleted_ids" => [1, 3, 4]}
 api.pagination_first_response.meta # => {"deleted_ids" => [1, 3, 4]}
 ```
 
+### Adjust headers dynamically
+
+If you need to add custom headers you can use `#with_headers` method. It accepts hash of headers
+that should be added to next request and yields client. It resets headers to default ones at the end
+and returns result of last operation specified inside block.
+
+```ruby
+api.with_headers("x-awesome-header" => "you-bet-i-am") do |adjusted_api_client|
+  adjusted_api_client.rentals
+end
+=> [BookingSync::API::Resource, BookingSync::API::Resource]
+```
+
 ### Logging
 
 Sometimes it's useful to see what data bookingsync-api gem sends and what it

data/lib/bookingsync/api/client.rb

@@ -14,6 +14,7 @@ require "bookingsync/api/client/change_overs"
 require "bookingsync/api/client/clients"
 require "bookingsync/api/client/destinations"
 require "bookingsync/api/client/fees"
+require "bookingsync/api/client/hosts"
 require "bookingsync/api/client/inquiries"
 require "bookingsync/api/client/living_rooms"
 require "bookingsync/api/client/nightly_rate_maps"
@@ -38,6 +39,9 @@ require "bookingsync/api/client/seasons"
 require "bookingsync/api/client/special_offers"
 require "bookingsync/api/client/sources"
 require "bookingsync/api/client/taxes"
+require "bookingsync/api/client/conversations"
+require "bookingsync/api/client/messages"
+require "bookingsync/api/client/participants"
 require "bookingsync/api/error"
 require "bookingsync/api/relation"
 require "bookingsync/api/response"
@@ -62,13 +66,17 @@ module BookingSync::API
     include BookingSync::API::Client::BookingsTags
     include BookingSync::API::Client::BookingsTaxes
     include BookingSync::API::Client::ChangeOvers
+    include BookingSync::API::Client::Conversations
     include BookingSync::API::Client::Clients
     include BookingSync::API::Client::Destinations
     include BookingSync::API::Client::Fees
+    include BookingSync::API::Client::Hosts
     include BookingSync::API::Client::Inquiries
     include BookingSync::API::Client::LivingRooms
+    include BookingSync::API::Client::Messages
     include BookingSync::API::Client::NightlyRateMaps
     include BookingSync::API::Client::StrictBookings
+    include BookingSync::API::Client::Participants
     include BookingSync::API::Client::Periods
     include BookingSync::API::Client::Payments
     include BookingSync::API::Client::PaymentGateways
@@ -274,6 +282,19 @@ module BookingSync::API
       end
     end
 
+    # Yields client with temporarily modified headers.
+    #
+    # @param extra_headers [Hash] Additional headers added to next request.
+    # @yieldreturn [BookingSync::API::Client] Client with modified default headers.
+    # @return [Array<BookingSync::API::Resource>|BookingSync::API::Resource|String|Object] Client response
+    def with_headers(extra_headers = {}, &block)
+      original_headers = @conn.headers.dup
+      @conn.headers.merge!(extra_headers)
+      result = yield self
+      @conn.headers = original_headers
+      result
+    end
+
     private
 
     def middleware

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

@@ -0,0 +1,75 @@
+module BookingSync::API
+  class Client
+    module Conversations
+      # List conversations
+      #
+      # Returns all conversations 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 conversations.
+      #
+      # @example Get the list of conversations for the current account
+      #   conversations = @api.conversations
+      #   conversations.first.subject # => "Question"
+      # @see http://developers.bookingsync.com/reference/endpoints/conversations/#list-conversations
+      def conversations(options = {}, &block)
+        paginate "inbox/conversations", options, &block
+      end
+
+      # Get a single conversation
+      #
+      # @param conversation [BookingSync::API::Resource|Integer] Conversation or ID
+      #   of the conversation.
+      # @return [BookingSync::API::Resource]
+      def conversation(conversation)
+        get("inbox/conversations/#{conversation}").pop
+      end
+
+      # Create a new conversation
+      #
+      # @param options [Hash] Conversation's attributes.
+      # @return [BookingSync::API::Resource] Newly created conversation.
+      def create_conversation(options = {})
+        post("inbox/conversations", conversations: [options]).pop
+      end
+
+      # Edit a conversation
+      #
+      # @param conversation [BookingSync::API::Resource|Integer] Conversation or ID of
+      #   the conversation to be updated.
+      # @param options [Hash] Conversation attributes to be updated.
+      # @return [BookingSync::API::Resource] Updated conversation on success,
+      #   exception is raised otherwise.
+      # @example
+      #   conversation = @api.conversations.first
+      #   @api.edit_conversation(conversation, { closed: true })
+      def edit_conversation(conversation, options = {})
+        put("inbox/conversations/#{conversation}", conversations: [options]).pop
+      end
+
+      # Connect conversation with booking
+      # @param conversation [BookingSync::API::Resource|Integer] Conversation or ID of
+      #   the conversation to be connected to booking
+      # @param options [Hash] Id of booking to be connected to conversation.
+      # @return [BookingSync::API::Resource] Conversation with updated links on success,
+      #   exception is raised otherwise.
+      # @example
+      #   @api.connect_booking_to_conversation(conversation, { id: 5 })
+      def connect_booking_to_conversation(conversation, options)
+        put("inbox/conversations/#{conversation}/connect_booking", bookings: [options]).pop
+      end
+
+      # Disconnect conversation from booking
+      # @param conversation [BookingSync::API::Resource|Integer] Conversation or ID of
+      #   the conversation connected to booking
+      # @param options [Hash] Id of booking to be disconnected from conversation.
+      # @return [BookingSync::API::Resource] Conversation with updated links on success,
+      #   exception is raised otherwise.
+      # @example
+      #   @api.disconnect_booking_from_conversation(conversation, { id: 5 })
+      def disconnect_booking_from_conversation(conversation, options)
+        put("inbox/conversations/#{conversation}/disconnect_booking", bookings: [options]).pop
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module BookingSync::API
+  class Client
+    module Hosts
+      # List hosts
+      #
+      # Returns all hosts 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 hosts.
+      #
+      # @example Get the list of hosts for the current account
+      #   hosts = @api.hosts
+      #   hosts.first.email # => "host_email@example.com"
+      # @see http://developers.bookingsync.com/reference/endpoints/hosts/#list-hosts
+      def hosts(options = {}, &block)
+        paginate :hosts, options, &block
+      end
+
+      # Get a single host
+      #
+      # @param host [BookingSync::API::Resource|Integer] Host or ID
+      #   of the host.
+      # @return [BookingSync::API::Resource]
+      def host(host)
+        get("hosts/#{host}").pop
+      end
+
+      # Create a new host
+      #
+      # @param options [Hash] Host's attributes.
+      # @return [BookingSync::API::Resource] Newly created host.
+      def create_host(options = {})
+        post(:hosts, hosts: [options]).pop
+      end
+
+      # Edit a host
+      #
+      # @param host [BookingSync::API::Resource|Integer] Host or ID of
+      #   the host to be updated.
+      # @param options [Hash] Host attributes to be updated.
+      # @return [BookingSync::API::Resource] Updated host on success,
+      #   exception is raised otherwise.
+      # @example
+      #   host = @api.hosts.first
+      #   @api.edit_host(host, { firstname: "Johnny" })
+      def edit_host(host, options = {})
+        put("hosts/#{host}", hosts: [options]).pop
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module BookingSync::API
+  class Client
+    module Messages
+      # List messages
+      #
+      # Returns all messages 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 messages.
+      #
+      # @example Get the list of messages for the current account
+      #   messages = @api.messages
+      #   messages.first.content # => "Message content"
+      # @see http://developers.bookingsync.com/reference/endpoints/messages/#list-messages
+      def messages(options = {}, &block)
+        paginate "inbox/messages", options, &block
+      end
+
+      # Get a single message
+      #
+      # @param message [BookingSync::API::Resource|Integer] Message or ID
+      #   of the message.
+      # @return [BookingSync::API::Resource]
+      def message(message)
+        get("inbox/messages/#{message}").pop
+      end
+
+      # Create a new message
+      #
+      # @param options [Hash] Message's attributes.
+      # @return [BookingSync::API::Resource] Newly created message.
+      def create_message(options = {})
+        post("inbox/messages", messages: [options]).pop
+      end
+
+      # Edit a message
+      #
+      # @param message [BookingSync::API::Resource|Integer] Message or ID of
+      #   the message to be updated.
+      # @param options [Hash] Message attributes to be updated.
+      # @return [BookingSync::API::Resource] Updated message on success,
+      #   exception is raised otherwise.
+      # @example
+      #   message = @api.messages.first
+      #   @api.edit_message(message, { content: "Updated message content" })
+      def edit_message(message, options = {})
+        put("inbox/messages/#{message}", messages: [options]).pop
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module BookingSync::API
+  class Client
+    module Participants
+      # List participants
+      #
+      # Returns all participants 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 participants.
+      #
+      # @example Get the list of participants for the current account
+      #   participants = @api.participants
+      #   participants.first.read_at # => "Fri, 02 Mar 2018 17:06:41 UTC +00:00"
+      # @see http://developers.bookingsync.com/reference/endpoints/participants/#list-participants
+      def participants(options = {}, &block)
+        paginate "inbox/participants", options, &block
+      end
+
+      # Get a single participant
+      #
+      # @param participant [BookingSync::API::Resource|Integer] Participant or ID
+      #   of the participant.
+      # @return [BookingSync::API::Resource]
+      def participant(participant)
+        get("inbox/participants/#{participant}").pop
+      end
+
+      # Create a new participant
+      #
+      # @param options [Hash] Participant's attributes.
+      # @return [BookingSync::API::Resource] Newly created participant.
+      def create_participant(options)
+        post("inbox/participants", participants: [options]).pop
+      end
+
+      # Edit a participant
+      #
+      # @param participant [BookingSync::API::Resource|Integer] Participant or ID of
+      #   the participant to be updated.
+      # @param options [Hash] Participant attributes to be updated.
+      # @return [BookingSync::API::Resource] Updated participant on success,
+      #   exception is raised otherwise.
+      # @example
+      #   participant = @api.participants.first
+      #   @api.edit_participant(participant, { read: true })
+      def edit_participant(participant, options = {})
+        put("inbox/participants/#{participant}", participants: [options]).pop
+      end
+    end
+  end
+end

data/lib/bookingsync/api/version.rb

@@ -1,5 +1,5 @@
 module BookingSync
   module API
-    VERSION = "0.1.8"
+    VERSION = "0.1.9"
   end
 end

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

@@ -0,0 +1,124 @@
+require "spec_helper"
+
+describe BookingSync::API::Client::Conversations do
+  let(:client) { BookingSync::API::Client.new(test_access_token) }
+
+  before { |ex| @casette_base_path = casette_path(casette_dir, ex.metadata) }
+
+  describe ".conversations", :vcr do
+    it "returns conversations" do
+      expect(client.conversations).not_to be_empty
+      assert_requested :get, bs_url("inbox/conversations")
+    end
+  end
+
+  describe ".conversation", :vcr do
+    let(:prefetched_conversation_id) {
+      find_resource("#{@casette_base_path}_conversations/returns_conversations.yml", "conversations")[:id]
+    }
+
+    it "returns a single conversation" do
+      conversation = client.conversation(prefetched_conversation_id)
+      expect(conversation.id).to eq prefetched_conversation_id
+    end
+  end
+
+  describe ".create_conversation", :vcr do
+    let(:assignee) { BookingSync::API::Resource.new(client, id: 1) }
+    let(:source) { BookingSync::API::Resource.new(client, id: 1) }
+    let(:attributes) do
+      { subject: "New Question", assignee_id: assignee.id, source_id: source.id }
+    end
+
+    it "creates a new conversation" do
+      client.create_conversation(attributes)
+      assert_requested :post, bs_url("inbox/conversations"),
+        body: { conversations: [attributes] }.to_json
+    end
+
+    it "returns newly created conversation" do
+      VCR.use_cassette("BookingSync_API_Client_Conversations/_create_conversation/creates_a_new_conversation") do
+        conversation = client.create_conversation(attributes)
+        expect(conversation.subject).to eq("New Question")
+        expect(conversation[:links][:assignee]).to eq(assignee.id)
+        expect(conversation[:links][:source]).to eq(source.id)
+      end
+    end
+  end
+
+  describe ".edit_conversation", :vcr do
+    let(:new_conversation_assignee) { BookingSync::API::Resource.new(client, id: 2) }
+    let(:created_conversation_id) {
+      find_resource("#{@casette_base_path}_create_conversation/creates_a_new_conversation.yml", "conversations")[:id]
+    }
+    let(:attributes) {
+      { closed: true, assignee_id: new_conversation_assignee.id }
+    }
+
+    it "updates given conversation by ID" do
+      client.edit_conversation(created_conversation_id, attributes)
+      assert_requested :put, bs_url("inbox/conversations/#{created_conversation_id}"),
+        body: { conversations: [attributes] }.to_json
+    end
+
+    it "returns updated conversation" do
+      VCR.use_cassette("BookingSync_API_Client_Conversations/_edit_conversation/updates_given_conversation_by_ID") do
+        conversation = client.edit_conversation(created_conversation_id, attributes)
+        expect(conversation).to be_kind_of(BookingSync::API::Resource)
+        expect(conversation[:links][:assignee]).to eq(new_conversation_assignee.id)
+      end
+    end
+  end
+
+  describe ".connect_booking_to_conversation", :vcr do
+    let(:booking_to_be_connected) { BookingSync::API::Resource.new(client, id: 40) }
+    let(:prefetched_conversation_id) {
+      find_resource("#{@casette_base_path}_conversations/returns_conversations.yml", "conversations")[:id]
+    }
+    let(:attributes) { { id: booking_to_be_connected.id } }
+
+    it "connects given conversation with booking" do
+      client.connect_booking_to_conversation(prefetched_conversation_id, attributes)
+      assert_requested :put, bs_url("inbox/conversations/#{prefetched_conversation_id}/connect_booking"),
+        body: { bookings: [attributes] }.to_json
+    end
+
+    it "returns conversation with updated links" do
+      casette_path = "BookingSync_API_Client_Conversations/_connect_booking_to_conversation" \
+                     "/connects_given_conversation_with_booking"
+      VCR.use_cassette(casette_path) do
+        initial_conversation = client.conversation(prefetched_conversation_id)
+        expect(initial_conversation[:links][:bookings]).to match_array []
+        conversation = client.connect_booking_to_conversation(prefetched_conversation_id, attributes)
+        expect(conversation).to be_kind_of(BookingSync::API::Resource)
+        expect(conversation[:links][:bookings]).to match_array [booking_to_be_connected.id]
+      end
+    end
+  end
+
+  describe ".disconnect_booking_from_conversation", :vcr do
+    let(:booking_to_be_disconnected) { BookingSync::API::Resource.new(client, id: 40) }
+    let(:prefetched_conversation_id) {
+      find_resource("#{@casette_base_path}_conversations/returns_conversations.yml", "conversations")[:id]
+    }
+    let(:attributes) { { id: booking_to_be_disconnected.id } }
+
+    it "disconnects given conversation from booking" do
+      client.disconnect_booking_from_conversation(prefetched_conversation_id, attributes)
+      assert_requested :put, bs_url("inbox/conversations/#{prefetched_conversation_id}/disconnect_booking"),
+        body: { bookings: [attributes] }.to_json
+    end
+
+    it "returns conversation with updated links" do
+      casette_path = "BookingSync_API_Client_Conversations/_disconnect_booking_from_conversation" \
+                     "/disconnects_given_conversation_from_booking"
+      VCR.use_cassette(casette_path) do
+        initial_conversation = client.conversation(prefetched_conversation_id)
+        expect(initial_conversation[:links][:bookings]).to match_array [booking_to_be_disconnected.id]
+        conversation = client.disconnect_booking_from_conversation(prefetched_conversation_id, attributes)
+        expect(conversation).to be_kind_of(BookingSync::API::Resource)
+        expect(conversation[:links][:bookings]).to match_array []
+      end
+    end
+  end
+end