homeaway-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c656cecfa3035e83cc8c49914b151d25db76c72c
+  data.tar.gz: 9e2cb5e8dbf453da945626c06b4347dc2784cabc
+SHA512:
+  metadata.gz: 0be559350c906f672c84d6cbbde4de649fb6bee81dcdc6782bbb214420d522ecfb792b49a2d5ed44d985677646089040caaf005da2255c5d8e25ed08e495b1f2
+  data.tar.gz: e645145aa8bd807a36abd341a6694720a915473ddc740d8b2627b64e6d7ea41c6aafe6be4d22c16cf1d541b09a0e46e1701c0d9e8762a82e4760b44ecf159b55

data/Gemfile

@@ -0,0 +1,18 @@
+# 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.
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,209 @@
+Certain components of this software are provided or made available only
+subject to the licenses under which such components were licensed to
+HomeAway.  The relevant components and corresponding licenses are listed
+[in the folder in the distribution titled 'licenses'].  In any event, the
+disclaimer of warranty and limitation of liability provision in this
+Agreement will apply to all Software in this distribution.
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2015 HomeAway.com, Inc.
+
+   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.

data/README.md

@@ -0,0 +1,127 @@
+# HomeAway API
+
+A Ruby SDK to interact with the HomeAway API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'homeaway_api'
+```
+
+And then execute in the checked out directory to install into your system gems:
+
+    $ rake install
+
+or to install into your bundle:
+
+    $ bundle exec rake install
+
+## Usage
+
+### Authenticating
+
+In order to use this gem, you must first have a HomeAway API client ID and client secret. Both of these can be obtained by registering yourself as an API developer at https://www.homeaway.com/platform/myClients
+
+Once you have these credentials, to use this gem:
+
+```ruby
+require 'homeaway_api'
+client = HomeAway::API::Client.new(client_id: your_client_id, client_secret: your_client_secret)
+```
+
+This will automatically have your client authenticate with HomeAway. If you wish to have your application be able to access the personal HomeAway data of the user of your application, you need to call:
+
+```ruby
+client.auth_url
+```
+
+which will return back a URL as a String that the user of your application must be sent to. It is up to you to define how that takes place. Once your user goes to that url they will prompted to login with their HomeAway credentials. As soon as they do that and authorize your application to access their HomeAway data, the client's web browser will be redirected back to the redirect url that you specified when you created your client above. This url will have a code appended to it as a parameter named code. Once you are able to grab that code, you can use it with this gem:
+
+```ruby
+client.oauth_code = code_received_from_redirect_url
+```
+
+As soon as you make that assignment, the client will contact HomeAway and obtain a token that can be used for interacting with the HomeAway for that user for that particular session. By default, this token has a 6 month expiration time.
+
+### Using an existing token
+
+If you have a token string saved from a previous use of the HomeAway API it can be reused with this SDK to avoid having your user login to HomeAway again.
+
+```ruby
+client = HomeAway::API::Client.new(
+      token: 'saved_token_value'
+  )
+```
+
+### Custom configuring the client
+
+You will usually not need to do this often as the defaults will be sufficient for most use cases, but if necessary, you can specify any subset of the fields below:
+
+```ruby
+client.configure do |c|
+    site: <site>, #override the hostname of the api
+    port: <port>, #defaults to 443
+    logger: <logger_instance>, #supply your own custom logger instance
+    cache_control: <value>, #set a custom cache control header to be sent on each request
+    auto_pagination: <true or false>, #will paginated resources automatically traverse their pages when being iterated over
+    connection_opts: <opts>, #set any connection options to the underlying Faraday connection object, must be a hash
+    page_size: <size>, #overwrite the default page size (10)
+    test_mode: <true or false> #enable or disable test mode, default disabled
+end
+```
+
+##  Operations
+
+Each of the operations is detailed in the generated Yard documentation for this gem. 
+
+##  Quickstart
+
+```ruby
+require 'homeaway_api'
+client = HomeAway::API::Client.new(client_id: your_client_id, client_secret: your_client_secret)
+response = @client.get_listing '123456', ['AVAILABILITY', 'RATES']
+paginator = @client.search '4 bathrooms new york'
+paginator.each do |search_result|
+  listing =  @client.get_listing search_result.listing_id, ['DETAILS', 'RATES', 'LOCATION']
+  puts listing
+end
+```
+
+##  hacurl
+
+If you install this gem, it will also install a command line utility named `hacurl`. `hacurl` is a tool that allows developers to easily interact with the HomeAway API without writing a single line of code. The available options:
+
+```
+$ Usage: hacurl [options] url
+    -i, --client-id CLIENT_ID        your client id
+    -s CLIENT_SECRET,                your client secret
+        --client-secret
+    -e, --email EMAIL                optional email address to use for operations that require 3-legged-oauth
+    -p, --password PASSWORD          optional password to use for operations that require 3-legged-oauth
+    -d, --data FILE                  path to file for any operations that require a body (PUT OR POST)
+    -X, --method METHOD              method to send (GET, PUT, POST)
+    -a, --get-auth                   only output the bearer authorization
+    -v, --verbose                    print verbose information
+    -t, --traveler                   login as a traveler
+    -o, --owner                      login as an owner (the default)
+```
+
+An example invocation would be:
+
+```
+$ hacurl -i <your_client_id> -s <your_client_secret> /public/listing?id=123456
+```
+
+## Other
+
+The full API documentation is located at: https://homeaway.com/platform/documentation
+
+## Contributing
+
+1. Fork it https://github.com/homeaway/homeaway_api_ruby
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:unit) do |spec|
+  spec.rspec_opts = '-b'
+end
+
+task :default => :unit

data/bin/hacurl

@@ -0,0 +1,176 @@
+#!/usr/bin/env ruby
+
+# 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'
+require 'optparse'
+require 'json'
+require 'mechanize'
+require 'cgi'
+require 'json_color'
+
+options = {
+    :auth_only => false,
+    :type => :owner
+}
+parser = OptionParser.new do |opts|
+  opts.banner = 'Usage: hacurl [options] url'
+
+  opts.on('-i', '--client-id CLIENT_ID', 'your client id') do |id|
+    options[:client_id] = id
+  end
+
+  opts.on('-s', '--client-secret CLIENT_SECRET', 'your client secret') do |secret|
+    options[:client_secret] = secret
+  end
+
+  opts.on('-e', '--email EMAIL', 'optional email address to use for operations that require 3-legged-oauth') do |email|
+    options[:email] = email
+  end
+
+  opts.on('-p', '--password PASSWORD', 'optional password to use for operations that require 3-legged-oauth') do |email|
+    options[:password] = email
+  end
+
+  opts.on('-d', '--data FILE', 'path to file for any operations that require a body (PUT OR POST)') do |path|
+    options[:data_path] = path
+  end
+
+  opts.on('-X', '--method METHOD', 'method to send (GET, PUT, POST)') do |method|
+    options[:method] = method.downcase.to_sym
+  end
+
+  opts.on('-a', '--get-auth', 'only output the bearer authorization') do
+    options[:auth_only] = true
+  end
+
+  opts.on('-v', '--verbose', 'print verbose information') do
+    options[:verbose] = true
+  end
+
+  opts.on('-t', '--traveler', 'login as a traveler') do
+    options[:type] = :traveler
+  end
+
+  opts.on('-o', '--owner', 'login as an owner (the default)') do
+    options[:type] = :owner
+  end
+
+end
+
+parser.parse!
+
+ARGV.clear if options[:auth_only]
+
+if ARGV.size == 0 and !options[:auth_only]
+  $stderr.puts 'url is requred'
+  $stderr.puts parser.help
+  exit 1
+end
+
+url = ARGV.first
+
+if options[:client_id].nil?
+  $stderr.puts 'client id is required'
+  $stderr.puts parser.help
+  exit 1
+end
+
+if options[:client_secret].nil?
+  $stderr.puts 'client secret is required'
+  $stderr.puts parser.help
+  exit 1
+end
+
+configuration = {
+    site: 'https://ws.homeaway.com',
+}
+
+method = :get
+allowed_methods = [:get, :post, :put]
+method = options[:method] if options[:method] && allowed_methods.include?(options[:method].downcase.to_sym)
+data = nil
+if options[:data_path]
+  unless File.exist?(options[:data_path])
+    $stderr.puts "#{:data_path} does not exist"
+    $stderr.puts parser.help
+    exit 1
+  end
+  file = File.open(options[:data_path], 'r')
+  data = (JSON.load(file)).to_hash
+  file.close
+end
+
+oauth_site = configuration[:site]
+oauth_site = configuration[:oauth_site] if configuration.has_key?(:oauth_site)
+
+client = HomeAway::API::Client.new(
+    client_id: options[:client_id],
+    client_secret: options[:client_secret],
+    cas_url: configuration[:cas_url],
+    site: configuration[:site],
+    oauth_site: oauth_site
+)
+
+if options[:email] and options[:password]
+  agent = Mechanize.new
+  auth_url = "https://cas.homeaway.com/auth/homeaway/login?service=https%3A%2F%2Fws.homeaway.com%2Foauth%2Fowner%2Fj_spring_cas_security_check%3Fspring-security-redirect%3Dhttps%253A%252F%252Fws.homeaway.com%252Foauth%252Fowner%252FauthorizeOwner%253Fclient_id%253D#{options[:client_id]}%2526"
+  auth_url = "https://cas.homeaway.com/auth/homeaway/login?service=https%3A%2F%2Fws.homeaway.com%2Foauth%2Ftraveler%2Fj_spring_cas_security_check%3Fspring-security-redirect%3Dhttps%253A%252F%252Fws.homeaway.com%252Foauth%252Ftraveler%252FauthorizeTraveler%253Fclient_id%253D#{options[:client_id]}%2526" if options[:type] == :traveler
+  agent.get(auth_url) do |login_page|
+    login_page.form_with(:id => 'login-form') do |form|
+      form.username = options[:email]
+      form.password = options[:password]
+    end.submit
+
+    agent.follow_redirect = false
+    agent.get("https://cas.homeaway.com/auth/homeaway/login?service=https://ws.homeaway.com/oauth/authenticate?clientId=#{options[:client_id]}") do |page|
+      unless page.response['location']
+        $stderr.puts 'Login failed. Please check the email and password provided'
+        exit 1
+      end
+      client.oauth_code = CGI.parse(URI.parse(page.response['location']).query)['ticket'].first
+    end
+  end
+end
+
+if options[:auth_only]
+  puts "Bearer #{client.token}"
+  exit 0
+end
+
+begin
+  uri = URI.parse(url)
+  begin
+    query = CGI.parse(uri.query)
+  rescue => _
+    query = {}
+  end
+  path = uri.path
+  path = "/public#{path}" unless path.start_with? '/public'
+  if method == :get
+    response = client.send(method, path, query)
+  else
+    response = client.send(method, path, data, query)
+  end
+rescue => e
+  $stderr.puts e.to_s
+  exit 1
+end
+response_hash = response.to_hash
+response_hash.delete('Metadata')
+puts JSON.pretty_generate(response._metadata.to_hash) if options[:verbose]
+puts JsonColor.colorize(JSON.pretty_generate(response_hash))
+exit 0