homeaway-api 1.0.0

data/lib/homeaway/api/adapters/faraday.rb

@@ -0,0 +1,67 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'faraday'
+require 'faraday-http-cache'
+require 'faraday_middleware/response/follow_redirects'
+require 'faraday_middleware/instrumentation'
+require 'faraday_middleware/response/mashify'
+require 'faraday_middleware/response/parse_json'
+
+module HomeAway
+  module API
+    # @private
+    module Adapters
+      # @private
+      class FaradayAdapter
+        # @private
+        def self.call(site, opts, headers, method, uri, body, params)
+          agent = Faraday::Connection.new(site, opts) do |conn|
+            conn.headers = headers
+            conn.adapter Faraday.default_adapter
+            conn.options.params_encoder = Faraday::FlatParamsEncoder
+            conn.use Faraday::HttpCache
+            conn.use FaradayMiddleware::Mashify, :mash_class => HomeAway::API::Response
+            conn.use FaradayMiddleware::ParseJson
+            conn.use FaradayMiddleware::Instrumentation
+            conn.use FaradayMiddleware::FollowRedirects
+          end
+          response = agent.send(method, uri) do |req|
+            req.body = body.to_json unless body.empty?
+            req.params = params unless params.empty?
+          end
+          self.transform response
+        end
+
+        # @private
+        def self.transform(response)
+          mash = response.body
+          mash = HomeAway::API::Response.new unless mash
+          mash._metadata.headers = HomeAway::API::Response.new(response.headers.to_hash) if response.respond_to? :headers
+          if response.respond_to? :status
+            mash._metadata.status_code = response.status
+            if mash._metadata.status_code.to_i >= 400
+              raise (HomeAway::API::Errors.for_http_code mash._metadata.status_code).new(mash)
+            end
+          end
+          if response.respond_to? :env
+            mash._metadata.request_headers = HomeAway::API::Response.new(response.env.request_headers.to_hash) if response.env.respond_to? :request_headers
+          end
+          mash
+        end
+      end
+    end
+  end
+end

data/lib/homeaway/api/adapters/hurley.rb

@@ -0,0 +1,83 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'hurley'
+require 'cgi'
+
+# @private
+module Hurley
+  # @private
+  class Query
+    # @private
+    def self.default
+      @default ||= Flat
+    end
+  end
+end
+
+
+module HomeAway
+  module API
+    # @private
+    module Adapters
+      # @private
+      class HurleyAdapter
+        # @private
+        def self.__update_opts(struct, opts)
+          opts.each_pair do |k, v|
+            method = "#{k}=".to_sym
+            if struct.respond_to?(method)
+              struct.send(method, v)
+            end
+          end
+        end
+
+        # @private
+        def self.call(site, opts, headers, method, uri, body, params)
+          begin
+            agent = Hurley::Client.new(site)
+            agent.header.update(headers)
+            self.__update_opts(agent.request_options, opts)
+            self.__update_opts(agent.ssl_options, opts)
+            request = agent.request(method, uri)
+            request.query.update(params) unless params.empty?
+            request.body = body.to_json unless (!body.respond_to?(:to_json) || body.empty?)
+            response = agent.call(request)
+          rescue => e
+            raise HomeAway::API::Errors::HomeAwayAPIError.new(e.message.to_s)
+          end
+          response_to_mash(response)
+        end
+
+        # @private
+        def self.response_to_mash(response)
+          body = response.body ||= {}
+          mash = HomeAway::API::Response.new
+          mash.update JSON.parse(body) unless body.empty?
+          mash._metadata = HomeAway::API::Response.new
+          mash._metadata.headers = response.header.to_hash if response.respond_to? :header
+          if response.respond_to? :status_code
+            mash._metadata.status_code = response.status_code
+            if mash._metadata.status_code.to_i >= 400
+              raise (HomeAway::API::Errors.for_http_code mash._metadata.status_code).new(mash)
+            end
+          end
+          mash.delete(:_metadata) if mash._metadata.empty?
+          mash
+        end
+      end
+    end
+  end
+end

data/lib/homeaway/api/client.rb

@@ -0,0 +1,224 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module HomeAway
+  module API
+    class Client
+
+      # @return [Hash] the global default configuration
+      def self.default_configuration
+        @@default_configuration ||= HomeAway::API::Util::Defaults.instance.to_hash
+      end
+
+      # Pass a block expecting a single hash parameter and set any global configuration settings
+      # that will be inherited by all instances created in the future
+      # @return [Hash] the global default configuration
+      def self.configure
+        yield @@default_configuration if block_given?
+        @@default_configuration
+      end
+
+      include HomeAway::API::Util::OAuth
+
+      attr_accessor :configuration
+      attr_reader :mode, :token, :token_expires
+
+      # @!attribute [rw] configuration
+      #   @return [Hash] the current client configuration
+
+      # @!attribute [r] token
+      #   @return [String] the current encoded token this client has
+
+      # @!attribute [r] mode
+      #   @return [Symbol] the current authentication state of this client. One of either :unauthorized, :two_legged, or :three_legged
+
+      # @!attribute [r] token_expires
+      #   @return [Time] the time that the current token in use on this client will expire
+
+
+      # Instantiates a new HomeAway API client
+      #
+      # @option opts [String] :client_id Your HomeAway API OAuth client id. Required here if not set globally
+      # @option opts [String] :client_secret Your HomeAway API OAuth client secret. Required here if not set globally
+      # @option opts [String] :token An existing token if you already have one saved from a previous usage of the api
+      # @return [HomeAway::API::Client] a newly instantiated HomeAway API client
+      def initialize(opts={})
+        @configuration = Hashie::Mash.new(self.class.default_configuration.merge(opts))
+        if opts.has_key?(:token)
+          @configuration[:manual_token_supplied] = true
+          set_token(opts.delete(:token))
+        end
+        validate_configuration
+        logger.debug("client initialized with configuration: #{@configuration}")
+        attempt_auth if @token.nil?
+      end
+
+      # Update the configuration of this particular instance of the client.
+      # Pass a block expecting a single hash parameter to update the configuration settings.
+      # @return [Hash] This client's configuration
+      def configure
+        yield @configuration if block_given?
+        validate_configuration
+        @configuration
+      end
+
+      # @return [Object] The current logger that has been configured
+      def logger
+        @configuration.logger
+      end
+
+      # @return [String] The current bearer auth token
+      def token
+        raise HomeAway::API::Errors::HomeAwayAPIError.new('Ticket must be supplied') if @token.nil?
+        @token
+      end
+
+      # @private
+      def marshal_dump
+        # we lose our logger instance naively here, marshal dump doesn't like
+        # one of its fields
+        dump_config = configuration.dup.to_hash
+        dump_config.delete('logger')
+        [@token, token_expires, dump_config]
+      end
+
+      # @private
+      def marshal_load(array)
+        @token = array[0]
+        @token_expires = array[1]
+        @configuration = Hashie::Mash.new(array[2])
+        @configuration.logger = HomeAway::API::Util::Defaults.instance.logger
+      end
+
+      # @return [Boolean] Has the token that the client is currently using expired?
+      def token_expired?
+        return false if @configuration[:manual_token_supplied]
+        begin
+          Time.now >= token_expires
+        rescue
+          true
+        end
+      end
+
+      # @private
+      def get(url, params={})
+        method :get, url, {}, params
+      end
+
+      # @private
+      def put(url, body, params={})
+        method :put, url, body, params
+      end
+
+      # @private
+      def post(url, body, params={})
+        method :post, url, body, params
+      end
+
+      # @private
+      def delete(url, params={})
+        method :delete, url, {}, params
+      end
+
+      # @private
+      def options(url, params={})
+        method :options, url, {}, params
+      end
+
+      private
+
+      def validate_configuration
+        required_uuids = [:client_id, :client_secret]
+        [required_uuids].flatten.each do |required_configuration_directive|
+          raise ArgumentError.new("#{required_configuration_directive.to_s} is required but not supplied") if (@configuration[required_configuration_directive] == nil || @configuration[required_configuration_directive].nil? || !configuration.has_key?(required_configuration_directive))
+        end
+        required_uuids.each do |uuid|
+          HomeAway::API::Util::Validators.uuid(@configuration[uuid])
+        end
+        true
+      end
+
+
+      def adapter
+        registered_adapters = {
+            :faraday => HomeAway::API::Adapters::FaradayAdapter,
+            :hurley => HomeAway::API::Adapters::HurleyAdapter
+        }
+        raise ArgumentError.new("Invalid adapter #{@configuration[:adapter]}") unless registered_adapters.keys.include? @configuration[:adapter]
+        logger.debug("using adapter: #{@configuration[:adapter]}")
+        registered_adapters[@configuration[:adapter]]
+      end
+
+      def headers
+        headers = {}
+        headers['content-type'] = 'application/json'
+        headers['Cache-control'] = @configuration[:cache_control]
+        headers['Authorization'] = "Bearer #{token}"
+        headers['User-Agent'] = "HomeAway API ruby_sdk/#{HomeAway::API::VERSION}"
+        headers['X-HomeAway-RequestMarker'] = SecureRandom.uuid
+        headers['X-HomeAway-TestMode'] = 'true' if @configuration[:test_mode]
+        logger.debug("Sending headers: #{headers.to_json}")
+        headers
+      end
+
+      def method(method, url, body, params)
+        if token_expired?
+          if @configuration[:auto_reauth]
+            logger.info('Token expired and auth_reauth is enabled, attempting 2 legged oauth.')
+            attempt_auth
+            logger.info("Re-authentication attempt completed. Current client status: #{@mode}")
+          else
+            raise HomeAway::API::Errors::TokenExpiredError.new('token is expired, please login again via the oauth url')
+          end
+        end
+        logger.info("#{method.to_s.upcase} to #{url} with params #{params.to_json}")
+        site = @configuration[:api_site] ||= @configuration[:site]
+        response = adapter.call(site, @configuration[:connection_opts], headers, method, url, body, params)
+        logger.debug("returning payload: #{response.to_json}")
+        response
+      end
+
+      def attempt_auth
+        begin
+          two_legged!
+          @mode = :two_legged
+        rescue => e
+          logger.info("failed to perform automatic 2 legged oauth due to: #{e.to_s}")
+          @mode = :unauthorized
+        end
+      end
+
+      def set_token(token)
+        @token = token
+        begin
+          listing '100000'
+          begin
+            me
+            logger.info('token supplied on client initialization provided 3-legged oauth')
+            @mode = :three_legged
+          rescue => e
+            logger.info('token supplied on client initialization provided 2-legged oauth')
+            @mode = :two_legged
+          end
+        rescue => e
+          logger.error("token supplied on client initialization was not valid: #{e.to_s}")
+          @mode = :unauthorized
+        end
+      end
+    end
+  end
+end
+
+require 'homeaway/api/domain/client_includes'

data/lib/homeaway/api/domain/add_message.rb

@@ -0,0 +1,45 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module HomeAway
+  module API
+    module Domain
+      module AddMessage
+
+        # Add a Message to a Conversation
+        #
+        # analogous to calling a POST on API url /public/addMessage
+        #
+        # @note user must be logged in via 3 legged oauth to call this function without error
+        #
+        # Headers:
+        # * X-HomeAway-DisplayLocale: If a locale is not specified in a query param, it will be searched for in the X-HomeAway-DisplayLocale Header. If it is not supplied in either area the default locale of the user will be selected if it exists. Otherwise the Accept-Language Header will be used.
+        #
+        # @param conversation_id [String] The Conversation UUID to load.
+        # @param message [String] The body of the message to add to the given conversation.
+        # @return [HomeAway::API::Response] the result of the call to the API
+        def add_message(conversation_id, message, opts={})
+          body = {
+              'message' => message.to_s,
+          }.merge(HomeAway::API::Util::Validators.query_keys(opts))
+          params = {
+              'conversationId' => HomeAway::API::Util::Validators.uuid(conversation_id)
+          }
+          post '/public/addMessage', body, params
+        end
+      end
+    end
+  end
+end

data/lib/homeaway/api/domain/client_includes.rb

@@ -0,0 +1,44 @@
+# Copyright (c) 2015 HomeAway.com, Inc.
+# All rights reserved.  http://www.homeaway.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'homeaway/api/domain/listing'
+require 'homeaway/api/domain/listing_reviews'
+require 'homeaway/api/domain/search'
+require 'homeaway/api/domain/quote'
+require 'homeaway/api/domain/my_listings'
+require 'homeaway/api/domain/my_inbox'
+require 'homeaway/api/domain/submit_review'
+require 'homeaway/api/domain/me'
+require 'homeaway/api/domain/my_reservations'
+require 'homeaway/api/domain/add_message'
+require 'homeaway/api/domain/conversation'
+
+module HomeAway
+  module API
+    class Client
+      include HomeAway::API::Domain::Listing
+      include HomeAway::API::Domain::ListingReviews
+      include HomeAway::API::Domain::Search
+      include HomeAway::API::Domain::Quote
+      include HomeAway::API::Domain::MyListings
+      include HomeAway::API::Domain::MyInbox
+      include HomeAway::API::Domain::SubmitReview
+      include HomeAway::API::Domain::Me
+      include HomeAway::API::Domain::MyReservations
+      include HomeAway::API::Domain::AddMessage
+      include HomeAway::API::Domain::Conversation
+    end
+  end
+end