homeaway-api 1.0.0

data/lib/homeaway/api/util/oauth.rb

@@ -0,0 +1,81 @@
+# 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 'oauth2'
+
+module HomeAway
+  module API
+    module Util
+      module OAuth
+
+        # @return [String] the Base64 encoded credentials for the current client
+        def credentials
+          Base64.strict_encode64 "#{@configuration.client_id}:#{@configuration.client_secret}"
+        end
+
+        # @private
+        def auth_url
+          oauth_client_strategy.authorize_url
+        end
+
+        # completes the oauth flow
+        # @param code [String] service ticket to authenticate
+        # @return [Boolean] true if the authentication succeeded, false otherwise
+        def oauth_code=(code)
+          begin
+            auth_code_strategy = oauth_client_strategy
+            token = auth_code_strategy.get_token(code, :headers => {'Authorization' => "Basic #{credentials}"})
+            @token = token.token
+            @token_expires = Time.at token.expires_at
+            @mode = :three_legged
+            return true
+          rescue => _
+            raise HomeAway::API::Errors::UnauthorizedError.new
+          end
+        end
+
+        private
+
+        def oauth_client
+          site = @configuration[:oauth_site] ||= @configuration[:site]
+          OAuth2::Client.new(@configuration.client_id,
+                             @configuration.client_secret,
+                             :site => site,
+                             :raise_errors => false
+          )
+        end
+
+        def oauth_client_strategy
+          client = oauth_client
+          client.auth_code
+        end
+
+        def two_legged!
+          begin
+            client = oauth_client
+            client_credentials_strategy = client.client_credentials
+            token = client_credentials_strategy.get_token
+            @token = token.token
+            @token_expires = Time.at token.expires_at
+            @mode = :two_legged
+            return true
+          rescue => _
+            raise HomeAway::API::Errors::UnauthorizedError.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/homeaway/api/util/validators.rb

@@ -0,0 +1,118 @@
+# 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 'cgi'
+
+module HomeAway
+  module API
+    module Util
+
+      # @private
+      module Validators
+
+        # @private
+        def self.uri_encoded(input)
+          CGI.escape input
+        end
+
+        # @private
+        def self.date(input)
+          if input.is_a? String
+            input = Chronic.parse(input, :ambiguous_time_range => :none)
+          end
+          raise ArgumentError.new('dates must be a parseable date string or a Ruby Time object') unless input.is_a? Time
+          input.to_time.utc.iso8601
+        end
+
+        # @private
+        def self.float(input, min=nil, max=nil)
+          begin
+            input_s = input.to_s
+            !!Float(input_s)
+            f = input_s.to_f
+            unless min == nil
+              raise ArgumentError.new("Supplied argument #{f} must be greater than #{min}") if f < min
+            end
+            unless max == nil
+              raise ArgumentError.new("Supplied argument #{f} must be less than #{max}") if f > max
+            end
+            return f
+          rescue
+            raise ArgumentError.new("Supplied argument #{input} must be a valid float value")
+          end
+        end
+
+        # @private
+        def self.integer(input, min=nil, max=nil)
+          begin
+            input_s = input.to_s
+            !!Integer(input_s)
+            i = input_s.to_i
+            unless min == nil
+              raise ArgumentError.new("Supplied argument #{i} must be greater than #{min}") if i < min
+            end
+            unless max == nil
+              raise ArgumentError.new("Supplied argument #{i} must be less than #{max}") if i > max
+            end
+            return i
+          rescue
+            raise ArgumentError.new("Supplied argument #{input} must be a valid integer value")
+          end
+        end
+
+        # @private
+        def self.boolean(input)
+          input_s = input.to_s
+          return true if input_s =~ (/^(true)$/i)
+          return false if input_s.empty? || input_s =~ (/^(false)$/i)
+          raise ArgumentError.new("Supplied argument #{input} must be a valid boolean value")
+        end
+
+        # @private
+        def self.camel_case(input)
+          input.to_s.camelize(:lower)
+        end
+
+        # @private
+        def self.snake_case(input)
+          input.to_s.underscore
+        end
+
+        # @private
+        def self.query_keys(hash)
+          raise ArgumentError.new('arguments must be a hash') unless hash.is_a? Hash
+          transformed = {}
+          hash.each_key do |key|
+            transformed[self.camel_case(key)] = hash[key]
+          end
+          transformed
+        end
+
+        # @private
+        def self.uuid(input)
+          uuid_regex = /\A([0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})\z/
+          raise ArgumentError.new("#{uuid.to_s} must be a valid uuid") unless input.to_s =~ uuid_regex
+          input.to_s
+        end
+
+        # @private
+        def self.array(input)
+          return nil if input == nil
+          [input].flatten
+        end
+      end
+    end
+  end
+end

data/lib/homeaway/api/version.rb

@@ -0,0 +1,20 @@
+# 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
+    VERSION = '1.0.0'
+  end
+end

data/lib/homeaway_api.rb

@@ -0,0 +1,43 @@
+# 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/version'
+require 'hashie'
+require 'base64'
+require 'logger'
+require 'rest-client'
+require 'openssl'
+require 'chronic'
+require 'active_support/all'
+
+require 'homeaway/api/errors/ha_api_errors'
+require 'homeaway/api/util/validators'
+require 'homeaway/api/util/defaults'
+require 'homeaway/api/util/oauth'
+require 'homeaway/api/paginator'
+require 'homeaway/api/response'
+require 'homeaway/api/client'
+require 'homeaway/api/adapters/faraday'
+require 'homeaway/api/adapters/hurley'
+
+require 'homeaway/api/domain/client_includes'
+
+module HomeAway
+  # The official HomeAway API Ruby SDK
+  # @author Charlie Meyer <cmeyer@homeaway.com>
+  module API
+
+  end
+end

metadata

@@ -0,0 +1,367 @@
+--- !ruby/object:Gem::Specification
+name: homeaway-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Charlie Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hurley
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_color
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby SDK for interacting with the HomeAway API
+email:
+- cmeyer@homeaway.com
+executables:
+- hacurl
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/hacurl
+- lib/homeaway/api/adapters/faraday.rb
+- lib/homeaway/api/adapters/hurley.rb
+- lib/homeaway/api/client.rb
+- lib/homeaway/api/domain/add_message.rb
+- lib/homeaway/api/domain/client_includes.rb
+- lib/homeaway/api/domain/conversation.rb
+- lib/homeaway/api/domain/listing.rb
+- lib/homeaway/api/domain/listing_reviews.rb
+- lib/homeaway/api/domain/me.rb
+- lib/homeaway/api/domain/my_inbox.rb
+- lib/homeaway/api/domain/my_listings.rb
+- lib/homeaway/api/domain/my_reservations.rb
+- lib/homeaway/api/domain/quote.rb
+- lib/homeaway/api/domain/search.rb
+- lib/homeaway/api/domain/submit_review.rb
+- lib/homeaway/api/errors/ha_api_errors.rb
+- lib/homeaway/api/paginator.rb
+- lib/homeaway/api/response.rb
+- lib/homeaway/api/util/defaults.rb
+- lib/homeaway/api/util/oauth.rb
+- lib/homeaway/api/util/validators.rb
+- lib/homeaway/api/version.rb
+- lib/homeaway_api.rb
+homepage: http://www.homeaway.com/platform/
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for interacting with the HomeAway API
+test_files: []