bookingsync-api 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49357703554dfb72c24e523586bde4e44de11470
-  data.tar.gz: 50f648b33c091403d8ca8561122c64cdd1ba2f42
+  metadata.gz: a2cb84342589240cfa192b7d61350efb89297de9
+  data.tar.gz: 17549658e975c21ff097e3bcbe7b92ce3aec0db8
 SHA512:
-  metadata.gz: 3c365736c033b2da829f778465f2faaf40019593ce40ceb6de61eccdd7c1bf5dd2dbd027caa453772b0064de050f161a866b7412f23089222bfc046a5e09d97d
-  data.tar.gz: 2f6e36a3ddda23970adc5921512e85256de13ab90e88150b347ba5fd94fa7e313a0c7046c9f1964bca7bc58d1da990544cf53463e6ace77c2b57b1c060c6a835
+  metadata.gz: 00db8c9b72935df38730f0288252cddcd85c343e6847b9983e7fe9c410a900cbff84ff2c401e9a88d66245b2dd4686152a7820892fd1cb54f20538f3c0de7b06
+  data.tar.gz: ad647464027c54595e3703d813447366845487d7031397b4d27f39f8cba15486228edc7097e1b49962bfd0995ff83a2339e229e295a466241dfd797f29d68ae6

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - 2.1.0
+  - 2.1.1
   - 2.0.0
   - 1.9.3

data/Gemfile

@@ -9,7 +9,8 @@ group 'test' do
   gem 'guard'
   gem 'guard-rspec'
   gem 'yard'
-  gem 'guard-yard'
+  gem 'ruby_gntp'
+  gem 'pry'
 end
 
 gemspec

data/Guardfile

@@ -1,10 +1,7 @@
-guard :rspec do
+guard :rspec, cmd: "bundle exec rspec --format p" do
+  watch(%r{^spec/(.+)_spec\.rb$})
   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/bookingsync/api/#{m[1]}_spec.rb" }
+  watch(%r{^lib/bookingsync/api/(.+)\.rb$})         { |m| "spec" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
-
-guard 'yard' do
-  watch(%r{lib/.+\.rb})
-end

data/README.md

@@ -24,7 +24,7 @@ Or install it yourself as:
 Gem assumes that you already have OAuth token for an account.
 
     api = BookingSync::API.new("OAUTH_TOKEN")
-    rentals = api.rentals # => [Sawyer::Resource, Sawyer::Resource]
+    rentals = api.rentals # => [BookingSync::API::Resource, BookingSync::API::Resource]
     rentals.first.name # => "Small apartment"
 
 ### Pagination
@@ -33,7 +33,7 @@ All endpoints returning a collection of resources can be paginated. There are th
 
 Specify `:per_page` and `:page` params. It's useful when implementing pagination on your site.
 
-    api.bookings(per_page: 10, page: 1) => [Sawyer::Resource, Sawyer::Resource, ...]
+    api.bookings(per_page: 10, page: 1) => [BookingSync::API::Resource, BookingSync::API::Resource, ...]
 
 Use pagination with a block.
 
@@ -43,7 +43,7 @@ Use pagination with a block.
 
 Fetch all resources (with multiple requests under the hood) and return one big array.
 
-    api.bookings(auto_paginate: true) => [Sawyer::Resource, Sawyer::Resource, ...]
+    api.bookings(auto_paginate: true) => [BookingSync::API::Resource, BookingSync::API::Resource, ...]
 
 ## Gem documentation
 
@@ -61,6 +61,14 @@ OR
 
     bundle exec guard
 
+### Recording VCR cassettes
+
+For developing bookingsync-api gem you need OAuth access token. In order to record a cassette,
+you need to run spec with below environment variables.
+
+    ACCESS_TOKEN=abc bundle exec rspec
+
+If you want to change a cassette, you need to delete it first.
 
 ## Contributing
 

data/bookingsync-api.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "faraday", "~> 0.9"
-  spec.add_dependency "sawyer"
-  spec.add_dependency "json"
+  spec.add_dependency "addressable"
+  spec.add_dependency "hashie"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
 end

data/lib/bookingsync/api.rb

@@ -1,7 +1,5 @@
 require "faraday"
-require "sawyer"
 
-require "bookingsync/ext/resource"
 require "bookingsync/api/version"
 require "bookingsync/api/client"
 

data/lib/bookingsync/api/client.rb

@@ -1,14 +1,48 @@
 require "bookingsync/api/middleware/authentication"
+require "bookingsync/api/client/amenities"
+require "bookingsync/api/client/billing_addresses"
 require "bookingsync/api/client/bookings"
+require "bookingsync/api/client/bookings_payments"
+require "bookingsync/api/client/clients"
+require "bookingsync/api/client/destinations"
 require "bookingsync/api/client/inquiries"
+require "bookingsync/api/client/periods"
+require "bookingsync/api/client/payments"
+require "bookingsync/api/client/photos"
+require "bookingsync/api/client/rates"
+require "bookingsync/api/client/rates_rules"
+require "bookingsync/api/client/rates_tables"
 require "bookingsync/api/client/rentals"
+require "bookingsync/api/client/rental_agreements"
+require "bookingsync/api/client/reviews"
+require "bookingsync/api/client/seasons"
+require "bookingsync/api/client/special_offers"
 require "bookingsync/api/error"
+require "bookingsync/api/relation"
+require "bookingsync/api/response"
+require "bookingsync/api/resource"
+require "bookingsync/api/serializer"
 
 module BookingSync::API
   class Client
+    include BookingSync::API::Client::Amenities
+    include BookingSync::API::Client::BillingAddresses
     include BookingSync::API::Client::Bookings
+    include BookingSync::API::Client::BookingsPayments
+    include BookingSync::API::Client::Clients
+    include BookingSync::API::Client::Destinations
     include BookingSync::API::Client::Inquiries
+    include BookingSync::API::Client::Periods
+    include BookingSync::API::Client::Payments
+    include BookingSync::API::Client::Photos
+    include BookingSync::API::Client::Rates
+    include BookingSync::API::Client::RatesRules
+    include BookingSync::API::Client::RatesTables
     include BookingSync::API::Client::Rentals
+    include BookingSync::API::Client::RentalAgreements
+    include BookingSync::API::Client::Reviews
+    include BookingSync::API::Client::Seasons
+    include BookingSync::API::Client::SpecialOffers
 
     MEDIA_TYPE = "application/vnd.api+json"
 
@@ -17,16 +51,25 @@ module BookingSync::API
     # Initialize new Client
     #
     # @param token [String] OAuth token
+    # @param options [Hash]
+    # @option options [String] base_url: Base URL to BookingSync site
     # @return [BookingSync::API::Client] New BookingSync API client
-    def initialize(token)
+    def initialize(token, options = {})
       @token = token
+      @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.url_prefix = api_endpoint
+      yield @conn if block_given?
     end
 
     # Make a HTTP GET request
     #
     # @param path [String] The path, relative to {#api_endpoint}
     # @param options [Hash] Query params for the request
-    # @return [Array<Sawyer::Resource>] Array of resources.
+    # @return [Array<BookingSync::API::Resource>] Array of resources.
     def get(path, options = {})
       request :get, path, query: options
     end
@@ -35,7 +78,7 @@ module BookingSync::API
     #
     # @param path [String] The path, relative to {#api_endpoint}
     # @param options [Hash] Body params for the request
-    # @return [Array<Sawyer::Resource>]
+    # @return [Array<BookingSync::API::Resource>]
     def post(path, options = {})
       request :post, path, options
     end
@@ -44,7 +87,7 @@ module BookingSync::API
     #
     # @param path [String] The path, relative to {#api_endpoint}
     # @param options [Hash] Body params for the request
-    # @return [Array<Sawyer::Resource>]
+    # @return [Array<BookingSync::API::Resource>]
     def put(path, options = {})
       request :put, path, options
     end
@@ -53,7 +96,7 @@ module BookingSync::API
     #
     # @param path [String] The path, relative to {#api_endpoint}
     # @param options [Hash] Body params for the request
-    # @return [Array<Sawyer::Resource>]
+    # @return [Array<BookingSync::API::Resource>]
     def delete(path, options = {})
       request :delete, path, options
     end
@@ -62,80 +105,110 @@ module BookingSync::API
     #
     # @return [String] URL to API endpoint
     def api_endpoint
-      "#{base_url}/api/v3"
+      URI.join(base_url, "api/v3").to_s
     end
 
-    protected
+    # Encode an object to a string for the API request.
+    #
+    # @param data [Object] The Hash or Resource that is being sent.
+    # @return [String] Object encoded into JSON string
+    def encode_body(data)
+      @serializer.encode(data)
+    end
 
-    # Make a HTTP request to given path
+    # Decode a String response body to a Resource.
+    #
+    # @param str [String] The String body from the response.
+    # @return [Object] Object resource
+    def decode_body(str)
+      @serializer.decode(str)
+    end
+
+    # Make a HTTP request to a path and returns an Array of Resources
     #
     # @param method [Symbol] HTTP verb to use.
     # @param path [String] The path, relative to {#api_endpoint}.
     # @param data [Hash] Data to be send in the request's body
     #   it can include query: key with requests params for GET requests
     # @param options [Hash] A customizable set of request options.
-    # @return [Array<Sawyer::Resource>] Array of resources.
-    def request(method, path, data, options = {})
-      if data.is_a?(Hash)
-        options[:query] = data.delete(:query) || {}
-        options[:query].keys.each do |key|
-          if options[:query][key].is_a?(Array)
-            options[:query][key] = options[:query][key].join(",")
-          end
-        end
-      end
-
-      @last_response = response = agent.call(method, path, data.to_json, options)
-      case response.status
-      when 204; [] # update/destroy response
-      when 200..299; json_api_to_array(response.data)
-      when 401; raise Unauthorized.new
-      when 422; raise UnprocessableEntity.new
-      end
+    # @return [Array<BookingSync::API::Resource>] Array of resources.
+    def request(method, path, data = nil, options = nil)
+      response = call(method, path, data, options)
+      response.respond_to?(:resources) ? response.resources : response
     end
 
+    # Make a HTTP GET request to a path with pagination support.
+    #
+    # @param options [Hash]
+    # @option options [Integer] per_page: Number of resources per page
+    # @option options [Integer] page: Number of page to return
+    # @option options [Boolean] auto_paginate: If true, all resources will
+    #   be returned. It makes multiple requestes underneath and joins the results.
+    #
+    # @yieldreturn [Array<BookingSync::API::Resource>] Batch of resources
+    # @return [Array<BookingSync::API::Resource>] Batch of resources
     def paginate(path, options = {}, &block)
       auto_paginate = options.delete(:auto_paginate)
+      response = call(:get, path, query: options)
+      data = response.resources.dup
 
-      data = request(:get, path, query: options)
-
-      if (block_given? or auto_paginate) && @last_response.rels[:next]
+      if (block_given? or auto_paginate) && response.rels[:next]
         first_request = true
         loop do
           if block_given?
-            yield(json_api_to_array(@last_response.data))
+            yield(response.resources)
           elsif auto_paginate
-            data.concat(json_api_to_array(@last_response.data)) unless first_request
+            data.concat(response.resources) unless first_request
             first_request = false
           end
-          break unless @last_response.rels[:next]
-          @last_response = @last_response.rels[:next].get
+          break unless response.rels[:next]
+          response = response.rels[:next].get
         end
       end
 
       data
     end
 
-    private
-
-    # Return collection of resources
+    # Make a HTTP request to given path and returns Response object.
     #
-    # In jsonapi spec every response has format
-    # {resources => [{resource}, {resource}]. This method returns the inner Array
-    # @param data [Sawyer::Resource]  Sawyer resource from response.data
-    # @return [<Sawyer::Resource>] An Array of resources
-    # FIXME: This could have better name
-    def json_api_to_array(data)
-      data.to_hash.values.flatten
-    end
+    # @param method [Symbol] HTTP verb to use.
+    # @param path [String] The path, relative to {#api_endpoint}.
+    # @param data [Hash] Data to be send in the request's body
+    #   it can include query: key with requests params for GET requests
+    # @param options [Hash] A customizable set of request options.
+    # @return [BookingSync::API::Response] A Response object.
+    def call(method, path, data = nil, options = nil)
+      if [:get, :head].include?(method)
+        options = data
+        data = nil
+      end
+      options ||= {}
 
-    def agent
-      @agent ||= Sawyer::Agent.new(api_endpoint, sawyer_options) do |http|
-        http.headers[:accept] = MEDIA_TYPE
-        http.headers[:content_type] = MEDIA_TYPE
+      if options.has_key?(:query)
+        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
+        if headers = options[:headers]
+          req.headers.update headers
+        end
+      end
+      handle_response(res)
     end
 
+    private
+
     def middleware
       Faraday::RackBuilder.new do |builder|
         builder.use :authentication, token
@@ -143,21 +216,18 @@ module BookingSync::API
       end
     end
 
-    def sawyer_options
-      {faraday: Faraday.new(faraday_options)}
-    end
-
     def faraday_options
       {builder: middleware, ssl: {verify: verify_ssl?}}
     end
 
     # Return BookingSync base URL. Default is https://www.bookingsync.com
     # it can be altered via ENV variable BOOKINGSYNC_URL which
-    # is useful in specs when recording vcr cassettes
+    # is useful in specs when recording vcr cassettes. In also can be passed
+    # as :base_url option when initializing the Client object
     #
     # @return [String] Base URL to BookingSync
     def base_url
-      ENV.fetch "BOOKINGSYNC_URL", "https://www.bookingsync.com"
+      @base_url || ENV.fetch("BOOKINGSYNC_URL", "https://www.bookingsync.com")
     end
 
     # Return true if SSL cert should be verified
@@ -169,5 +239,32 @@ module BookingSync::API
     def verify_ssl?
       ENV["BOOKINGSYNC_VERIFY_SSL"] == "false" ? false : true
     end
+
+    # Expand an URL template into a full URL
+    #
+    # @param url [String|Addressable::Template] - An URL to be expanded
+    # @param options [Hash] - Variables which will be used to expand
+    # @return [String] - Expanded URL
+    def expand_url(url, options = nil)
+      tpl = url.respond_to?(:expand) ? url : Addressable::Template.new(url.to_s)
+      tpl.expand(options || {}).to_s
+    end
+
+    # Process faraday response.
+    #
+    # @param faraday_response [Faraday::Response] - A response to process
+    # @raise [BookingSync::API::Unauthorized] - On unauthorized user
+    # @raise [BookingSync::API::UnprocessableEntity] - On validations error
+    # @return [BookingSync::API::Response|NilClass]
+    def handle_response(faraday_response)
+      response = Response.new(self, faraday_response)
+      case response.status
+      when 204; nil # destroy/cancel
+      when 200..299; response
+      when 401; raise Unauthorized.new
+      when 422; raise UnprocessableEntity.new
+      else nil
+      end
+    end
   end
 end

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

@@ -0,0 +1,22 @@
+module BookingSync::API
+  class Client
+    module Amenities
+      # List amenities
+      #
+      # Returns amenities 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 amenities.
+      #
+      # @example Get the list of amenities for the current account
+      #   amenities = @api.amenities
+      #   amenities.first.title # => "Internet"
+      # @example Get the list of amenities only with title and rental_id for smaller response
+      #   @api.amenities(fields: [:title, :rental_id])
+      # @see http://docs.api.bookingsync.com/reference/endpoints/amenities/#list-amenities
+      def amenities(options = {}, &block)
+        paginate :amenities, options, &block
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module BookingSync::API
+  class Client
+    module BillingAddresses
+      # List billing addresses
+      #
+      # Returns billing addresses 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 billing addresses.
+      #
+      # @example Get the list of billing addresses for the current account
+      #   billing_addresses = @api.billing_addresses
+      #   billing_addresses.first.city # => "Paris"
+      # @example Get the list of billing addresses only with city and address1 for smaller response
+      #   @api.billing_addresses(fields: [:city, :address1])
+      # @see http://docs.api.bookingsync.com/reference/endpoints/billing addresss/#list-billing-addresses
+      def billing_addresses(options = {}, &block)
+        paginate :billing_addresses, options, &block
+      end
+    end
+  end
+end