bookingsync-api 0.0.6 → 0.0.7

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

@@ -6,7 +6,7 @@ module BookingSync::API
       # Returns rentals 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<Sawyer::Resource>] Array of rentals.
+      # @return [Array<BookingSync::API::Resource>] Array of rentals.
       #
       # @example Get the list of rentals for the current account
       #   rentals = @api.rentals
@@ -17,6 +17,44 @@ module BookingSync::API
       def rentals(options = {}, &block)
         paginate :rentals, options, &block
       end
+
+      # Create a new rental
+      #
+      # @param options [Hash] rental attributes
+      # @return [BookingSync::API::Resource] Newly created rental
+      def create_rental(options = {})
+        post(:rentals, rentals: [options]).pop
+      end
+
+      # Edit a rental
+      #
+      # @param rental [BookingSync::API::Resource|Integer] rental or ID of the rental
+      # to be updated
+      # @param options [Hash] rental attributes to be updated
+      # @return [BookingSync::API::Resource] Updated rental on success, exception is raised otherwise
+      # @example
+      #   rental = @api.rentals.first
+      #   @api.edit_rental(rental, { sleeps: 3 })
+      def edit_rental(rental, options = {})
+        put("rentals/#{rental}", rentals: [options]).pop
+      end
+
+      # Cancel a rental
+      #
+      # @param rental [BookingSync::API::Resource|Integer] rental or ID of the rental
+      # to be canceled
+      # @return [Array] An empty Array on success, exception is raised otherwise
+      def cancel_rental(rental, options = {})
+        delete "rentals/#{rental}"
+      end
+
+      # Get a single rental
+      #
+      # @param rental [BookingSync::API::Resource|Integer] Rental or ID of the rental
+      # @return [BookingSync::API::Resource]
+      def rental(rental)
+        get("rentals/#{rental}").pop
+      end
     end
   end
 end

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

@@ -0,0 +1,31 @@
+module BookingSync::API
+  class Client
+    module Reviews
+      # List reviews
+      #
+      # Returns reviews 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 reviews.
+      #
+      # @example Get the list of reviews for the current account
+      #   reviews = @api.reviews
+      #   reviews.first.name # => "John Smith"
+      # @example Get the list of reviews only with name and comment for smaller response
+      #   @api.reviews(fields: [:name, :comment])
+      # @see http://docs.api.bookingsync.com/reference/endpoints/reviews/#list-reviews
+      def reviews(options = {}, &block)
+        paginate :reviews, options, &block
+      end
+
+      # Create a new review
+      #
+      # @param booking_id [Integer] ID of the booking
+      # @param options [Hash] review attributes
+      # @return [BookingSync::API::Resource] Newly created review
+      def create_review(booking_id, options = {})
+        post(:reviews, booking_id: booking_id, reviews: [options]).pop
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module BookingSync::API
+  class Client
+    module Seasons
+      # List seasons
+      #
+      # Returns seasons 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 seasons.
+      #
+      # @example Get the list of seasons for the current account
+      #   seasons = @api.seasons
+      #   seasons.first.name # => "Season 2"
+      # @example Get the list of seasons only with name and ratio for smaller response
+      #   @api.seasons(fields: [:name, :ratio])
+      # @see http://docs.api.bookingsync.com/reference/endpoints/seasons/#list-seasons
+      def seasons(options = {}, &block)
+        paginate :seasons, options, &block
+      end
+
+      # 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
+      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
+      # @example
+      #   season = @api.seasons.first
+      #   @api.edit_season(season, { name: "Some season" })
+      def edit_season(season, options = {})
+        put("seasons/#{season}", seasons: [options]).pop
+      end
+
+      # 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 = {})
+        delete "seasons/#{season}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module BookingSync::API
+  class Client
+    module SpecialOffers
+      # List special_offers
+      #
+      # 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.
+      #
+      # @example Get the list of special_offers for the current account
+      #   special_offers = @api.special_offers
+      #   special_offers.first.name # => "Spring discount"
+      # @example Get the list of special_offers only with name and rental_id for smaller response
+      #   @api.special_offers(fields: [:name, :rental_id])
+      # @see http://docs.api.bookingsync.com/reference/endpoints/special_offers/#list-special_offers
+      def special_offers(options = {}, &block)
+        paginate :special_offers, options, &block
+      end
+
+      # Create a new special_offer
+      #
+      # @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
+      end
+
+      # 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
+      # @return [BookingSync::API::Resource] Updated special offer on success,
+      # exception is raised otherwise
+      # @example
+      #   special_offer = @api.special_offers.first
+      #   @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
+      #
+      # @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 = {})
+        delete "special_offers/#{special_offer}"
+      end
+    end
+  end
+end

data/lib/bookingsync/api/relation.rb

@@ -0,0 +1,87 @@
+module BookingSync::API
+  class Relation
+    attr_reader :client, :name, :href_template, :method
+
+    # Build a hash of Relations from the `links` key in JSON API response.
+    #
+    # @param client [BookingSync::API::Client] The client that made the HTTP
+    #   request.
+    # @param links [Hash] Hash of relation_name => relation options.
+    # @return [Hash] Hash of relation_name => relation elements.
+    def self.from_links(client, links)
+      relations = {}
+      links.each do |name, options|
+        relations[name] = from_link(client, name, options)
+      end if links
+      relations
+    end
+
+    # Build a single Relation from the given options.
+    #
+    # @param client [BookingSync::API::Client] The client that made the HTTP
+    #   request
+    #
+    # @param name [Symbol] Name of the Relation.
+    # @param options [Hash] A Hash containing the other Relation properties.
+    # @option options [String] href: The String URL of the next action's location.
+    # @option options [String] method: The optional String HTTP method.
+    # @return [BookingSync::API::Relation] New relation
+    def self.from_link(client, name, options)
+      case options
+      when Hash
+        new client, name, options[:href], options[:method]
+      when String
+        new client, name, options
+      end
+    end
+
+    # A Relation represents an available next action for a resource.
+    #
+    # @param client [BookingSync::API::Client] The client that made the HTTP
+    #   request.
+    # @param name [Symbol] The name of the relation.
+    # @param href [String] The String URL of the location of the next action.
+    # @param method [Symbol] The Symbol HTTP method. Default: :get
+    def initialize(client, name, href, method = nil)
+      @client = client
+      @name = name.to_sym
+      @href = href
+      @href_template = Addressable::Template.new(href.to_s)
+      @method = (method || :get).to_sym
+      @available_methods = Set.new methods || [@method]
+    end
+
+    # Make an API request with the curent Relation using GET.
+    #
+    # @param options [Hash] Options to configure the API request.
+    # @option options [Hash] headers: Hash of API headers to set.
+    # @option options [Hash] query: Hash of URL query params to set.
+    # @option options [Symbol] method: Symbol HTTP method.
+    # @return [BookingSync::API::Response] A response
+    def get(options = nil)
+      options ||= {}
+      options[:method] = :get
+      call options
+    end
+
+    def href(options = nil)
+      return @href if @href_template.nil?
+      @href_template.expand(options || {}).to_s
+    end
+
+    # Make an API request with the curent Relation.
+    #
+    # @param data [Hash|String] The Optional Hash or Resource body to be sent.
+    #   :get or :head requests can have no body, so this can be the options Hash
+    #   instead.
+    # @param options [Hash] A Hash of option to configure the API request.
+    # @option options [Hash] headers: A Hash of API headers to set.
+    # @option options [Hash] query: Hash of URL query params to set.
+    # @option options [Symbol] method: Symbol HTTP method.
+    # @return [BookingSync::API::Response]
+    def call(data = nil, options = nil)
+      m = options && options[:method]
+      @client.call m || @method, @href_template, data, options || {}
+    end
+  end
+end

data/lib/bookingsync/api/resource.rb

@@ -0,0 +1,58 @@
+require "hashie"
+
+module BookingSync::API
+  class Resource < Hash
+    include Hashie::Extensions::MethodAccess
+    attr_reader :_client, :_rels, :_links, :_resources_key
+
+    # Initialize a Resource with the given links and data.
+    #
+    # @param client [BookingSync::API::Client] The client that made the API request.
+    # @param data [Hash] Hash of key/value properties.
+    # @param links [Hash] Hash of link templates for this resource.
+    # @param resources_key [Symbol|String] Key in response body under which
+    def initialize(client, data = {}, links = {}, resources_key = nil)
+      @_links = links
+      @_client = client
+      @_resources_key = resources_key
+      data.each do |key, value|
+        self[key.to_sym] = process_value(value)
+      end
+      @_rels = Relation.from_links(client, links)
+    end
+
+    # Process an individual value of this resource. Hashes get exploded
+    # into another Resource, and Arrays get their values processed too.
+    #
+    # @param value [Object] An Object value of a Resource's data.
+    # @return [Object] An Object to set as the value of a Resource key.
+    def process_value(value)
+      case value
+      when Hash  then self.class.new(@_client, value, @_links)
+      when Array then value.map { |v| process_value(v) }
+      else value
+      end
+    end
+
+    # Make associations accessible
+    #
+    # @param method [Symbol] Name of association
+    # @param args [Array] Array of additional arguments
+    def method_missing(method, *args)
+      association_key = :"#{@_resources_key}.#{method}"
+      if self[:links] && self[:links].has_key?(method)
+        ids = self[:links][method]
+        return [] if !ids or ids.empty?
+        options = {uri: {association_key => ids}}
+        options.merge!(query: args.first) if args.first.is_a?(Hash)
+        @_rels[association_key].get(options).resources
+      else
+        super
+      end
+    end
+
+    def to_s
+      id.to_s
+    end
+  end
+end

data/lib/bookingsync/api/response.rb

@@ -0,0 +1,79 @@
+require "addressable/template"
+
+module BookingSync::API
+  class Response
+    SPECIAL_JSONAPI_FIELDS = %w(links linked meta)
+    attr_reader :client, :status, :headers, :data, :rels, :body
+
+    # Build a Response after a completed request.
+    #
+    # @param client [BookingSync::API::Client] The client that is
+    #   managing the API connection.
+    # @param res [Faraday::Response] Faraday response object
+    def initialize(client, res)
+      @client  = client
+      @status  = res.status
+      @headers = res.headers
+      @env     = res.env
+      @body    = res.body
+    end
+
+    # Turn parsed contents from an API response into a Resource or
+    # collection of Resources.
+    #
+    # @param hash [Hash] A Hash of resources parsed from JSON.
+    # @return [Array] An Array of Resources.
+    def process_data(hash, links)
+      Array(hash).map do |hash|
+        Resource.new(client, hash, links, resources_key)
+      end
+    end
+
+    # Return name of the key in the response body hash
+    # where fetched resources are, like bookings or rentals
+    #
+    # @return [Symbol] Key name in the body hash
+    def resources_key
+      decoded_body.keys.delete_if { |k|
+        SPECIAL_JSONAPI_FIELDS.include?(k)
+      }.pop
+    end
+
+    # Return an array of Resources from the response body
+    #
+    # @return [Array<BookingSync::API::Resource>]
+    def resources
+      @resources ||= process_data(decoded_body[resources_key], links)
+    end
+
+    # Return an array of links templates from the response body,
+    # it's the contents of links hash
+    # {'links': {'rentals.photos':'https://www.bookingsync.com/api/v3/photos/{rentals.photos}'}}
+    #
+    # @return [Hash] Hash of links to associated resources
+    def links
+      @links ||= decoded_body[:links]
+    end
+
+    # Return link relations from 'Link' response header
+    #
+    # @return [Array] An array of Relations
+    def rels
+      @rels ||= process_rels
+    end
+
+    private
+
+    def decoded_body
+      @decoded_body ||= @client.decode_body(body) || {}
+    end
+
+    def process_rels
+      links = ( @headers["Link"] || "" ).split(', ').map do |link|
+        href, name = link.match(/<(.*?)>; rel="(\w+)"/).captures
+        [name.to_sym, Relation.from_link(@client, name, :href => href)]
+      end
+      Hash[*links.flatten]
+    end
+  end
+end

data/lib/bookingsync/api/serializer.rb

@@ -0,0 +1,100 @@
+require 'date'
+require 'time'
+require 'json'
+
+module BookingSync::API
+  class Serializer
+    # Public: Wraps a serialization format for Sawyer.  Nested objects are
+    # prepared for serialization (such as changing Times to ISO 8601 Strings).
+    # Any serialization format that responds to #dump and #load will work.
+    def initialize(dump_method_name = nil, load_method_name = nil)
+      @format = JSON
+      @dump = @format.method(dump_method_name || :dump)
+      @load = @format.method(load_method_name || :load)
+    end
+
+    # Public: Encodes an Object (usually a Hash or Array of Hashes).
+    #
+    # data - Object to be encoded.
+    #
+    # Returns an encoded String.
+    def encode(data)
+      @dump.call(encode_object(data))
+    end
+
+    alias dump encode
+
+    # Public: Decodes a String into an Object (usually a Hash or Array of
+    # Hashes).
+    #
+    # data - An encoded String.
+    #
+    # Returns a decoded Object.
+    def decode(data)
+      return nil if data.nil? || data.empty?
+      decode_object(@load.call(data))
+    end
+
+    alias load decode
+
+    def encode_object(data)
+      case data
+      when Hash then encode_hash(data)
+      when Array then data.map { |o| encode_object(o) }
+      else data
+      end
+    end
+
+    def encode_hash(hash)
+      hash.keys.each do |key|
+        case value = hash[key]
+        when Date then hash[key] = value.to_time.utc.xmlschema
+        when Time then hash[key] = value.utc.xmlschema
+        when Hash then hash[key] = encode_hash(value)
+        end
+      end
+      hash
+    end
+
+    def decode_object(data)
+      case data
+      when Hash then decode_hash(data)
+      when Array then data.map { |o| decode_object(o) }
+      else data
+      end
+    end
+
+    def decode_hash(hash)
+      hash.keys.each do |key|
+        hash[key.to_sym] = decode_hash_value(key, hash.delete(key))
+      end
+      hash
+    end
+
+    def decode_hash_value(key, value)
+      if time_field?(key, value)
+        if value.is_a?(String)
+          begin
+            Time.parse(value)
+          rescue ArgumentError
+            value
+          end
+        elsif value.is_a?(Integer) || value.is_a?(Float)
+          Time.at(value)
+        else
+          value
+        end
+      elsif value.is_a?(Hash)
+        decode_hash(value)
+      elsif value.is_a?(Array)
+        value.map { |o| decode_hash_value(key, o) }
+      else
+        value
+      end
+    end
+
+    def time_field?(key, value)
+      value && (key =~ /_(at|on)\z/ || key =~ /(\A|_)date\z/)
+    end
+  end
+end