tourcms 0.1.0

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'xml-object'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    xml-object (0.9.93)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda
+  xml-object

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Alex Kremer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# tourcms
+
+A simple wrapper for connecting to [TourCMS Marketplace API](http://www.tourcms.com/support/api/mp/). This wrapper mirrors the TourCMS PHP library.
+
+## Install
+
+	gem install tourcms
+	
+## Usage
+
+Using the library is as simple as creating a **TourCMS::Connection** object:
+
+	conn = TourCMS::Connection.new(marketplace_id, private_key, result_type)
+	
+Your Marketplace ID and Private Key can be found in the TourCMS Partner Portal. The result type can be one of **obj** or **raw** where **raw** will return the raw XML from the API and **obj** will return an XMLObject using the [XML-Object Gem](https://github.com/jordi/xml-object).
+
+### Working with your connection in Raw mode
+
+	# Instantiate the connection
+	conn = TourCMS::Connection.new("12345", "mydeepsecret", "raw")
+	# Check we're working
+	conn.api_rate_limit_status
+	=> "<?xml version="1.0" encoding="utf-8" ?><response><request>GET /api/rate_limit_status.xml</request>
+		<error>OK</error><remaining_hits>1999</remaining_hits><hourly_limit>2000</hourly_limit></response>"
+	# List the channels we have access to
+	conn.list_channels
+	=> ""<?xml version="1.0" encoding="utf-8" ?><response><request>GET /p/channels/list.xml</request>
+		<error>OK</error><channel>(...)</channel><channel>(...)</channel><channel>(...)</channel></response>"
+	# Show a particular channel
+	conn.show_channel(1234567)
+	=> ""<?xml version="1.0" encoding="utf-8" ?><response><request>GET /p/channels/list.xml</request>
+		<error>OK</error><channel>(...)</channel></response>"
+
+### Working with your connecting in Obj mode
+
+	# Instantiate the connection
+	conn = TourCMS::Connection.new("12345", "mydeepsecret", "obj")
+	# Check we're working
+	obj = conn.api_rate_limit_status
+	
+Note: XML-Object **does not support .inspect** so obj will return empty. XML-Object uses method_missing to access object properties so **you will need to know which property you're trying to access** beforehand -- Check the API docs.
+	
+	obj.hourly_limit
+	=> 2000
+	# List the channels we have access to
+	obj = conn.list_channels
+	obj.channel
+	=> [Array of Channel Objects]
+	obj.channel.first.channel_name
+	=> "My Adventure Tour Operator"
+	# Show a particular channel
+	obj = conn.show_channel(1234567)
+	obj.channel.channel_id
+	=> "1234567"
+	# Search for all tours in GB
+	obj = conn.search_tours(:country => "GB")
+	obj.tour.first.tour_name
+	=> "Canyoning"
+	
+### Passing parameters
+
+Many TourCMS methods accept parameters. Most methods take a hash of parameters like so:
+
+	obj = conn.search_tours({:country => "GB", :lang => "en"})
+
+## List of functions in TourCMS::Connection
+
+*	api\_rate\_limit\_status
+*	list\_channels
+*	show\_channel
+*	search\_tours
+*	search\_hotels\_range
+*	search\_hotels\_specific
+*	list\_tours
+*	list\_tour\_images
+*	show\_tour
+*	show\_tour\_departures
+*	show\_tour\_freesale
+
+## Contributing to tourcms
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Flextrip. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "tourcms"
+  gem.homepage = "http://github.com/flextrip/tourcms"
+  gem.license = "MIT"
+  gem.summary = %Q{A Ruby Library for the TourCMS API}
+  gem.description = %Q{A simple Ruby wrapper for interacting with the TourCMS API}
+  gem.email = "alex@flextrip.com"
+  gem.authors = ["Alex Kremer"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'xml-object'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tourcms #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/tour_cms/connection.rb

@@ -0,0 +1,123 @@
+module TourCMS
+  class Connection
+    def initialize(marketp_id, private_key, result_type = "raw")
+      Integer(marketp_id) rescue raise ArgumentError, "Marketplace ID must be an Integer"
+      @marketp_id = marketp_id
+      @private_key = private_key
+      @result_type = result_type
+      @base_url = "https://api.tourcms.com"
+    end
+    
+    def api_rate_limit_status(channel = 0)
+      return_result(request("/api/rate_limit_status.xml", channel))
+    end
+    
+    def list_channels
+      return_result(request("/p/channels/list.xml"))
+    end
+    
+    def show_channel(channel)
+      return_result(request("/c/channel/show.xml", channel))
+    end
+    
+    def search_tours(params = {}, channel = 0)
+      if channel == 0
+        return_result(request("/p/tours/search.xml", 0, params))
+      else
+        return_result(request("/c/tours/search.xml", channel, params))
+      end
+    end
+    
+    def search_hotels_range(params = {}, tour = "", channel = 0)
+      if channel == 0
+        return_result(request("/p/hotels/search_range.xml", 0, params.merge({"single_tour_id" => tour})))
+      else
+        return_result(request("/c/hotels/search_range.xml", channel, params.merge({"single_tour_id" => tour})))
+      end
+    end
+    
+    def search_hotels_specific(params = {}, tour = "", channel = 0)
+      if channel == 0
+        return_result(request("/p/hotels/search-avail.xml", 0, params.merge({"single_tour_id" => tour})))
+      else
+        return_result(request("/c/hotels/search-avail.xml", channel, params.merge({"single_tour_id" => tour})))
+      end
+    end
+    
+    def list_tours(channel = 0)
+      if channel == 0
+        return_result(request("/p/tours/list.xml"))
+      else
+        return_result(request("/c/tours/list.xml", channel))
+      end
+    end
+    
+    def list_tour_images(channel = 0)
+      if channel == 0
+        return_result(request("/p/tours/images/list.xml"))
+      else
+        return_result(request("/c/tours/images/list.xml", channel))
+      end
+    end
+    
+    def show_tour(tour, channel)
+      return_result(request("/c/tour/show", channel, {"id" => tour}))
+    end
+    
+    def show_tour_departures(tour, channel)
+      return_result(request("/c/tour/datesprices/dep/show.xml", channel, {"id" => tour}))
+    end
+    
+    def show_tour_freesale(tour, channel)
+      return_result(request("/c/tour/datesprices/freesale/show.xml", channel, {"id" => tour}))
+    end
+    
+    private
+    
+    def return_result(result)
+      if @result_type == "raw"
+        result
+      else
+        XMLObject.new(result)
+      end
+    end
+        
+    def construct_params(param_hash)
+      if param_hash.empty?
+        res = ""
+      else
+        qs = param_hash.stringify_keys.reject{|k,v| v.nil? || v.empty?}.collect{|k,v|"#{CGI.escape(k)}=#{CGI.escape(v)}"}.join("&")
+        qs.empty? ? res = "" : res = "?#{qs}"
+      end
+      res
+    end
+    
+    def generate_signature(path, verb, channel, outbound_time)
+      string_to_sign = "#{channel}/#{@marketp_id}/#{verb}/#{outbound_time}#{path}".strip
+      
+      dig = OpenSSL::HMAC.digest('sha256', @private_key, string_to_sign)
+      b64 = Base64.encode64(dig).chomp
+      CGI.escape(b64).gsub("+", "%20")
+    end
+    
+    def request(path, channel = 0, params = {}, verb = "GET")
+      url = @base_url + path + construct_params(params)
+      req_time = Time.now.utc
+      signature = generate_signature(path + construct_params(params), verb, channel, req_time.to_i)
+      
+      headers = {"Content-type" => "text/xml", "charset" => "utf-8", "Date" => req_time.strftime("%a, %d %b %Y %H:%M:%S GMT"), 
+        "Authorization" => "TourCMS #{channel}:#{@marketp_id}:#{signature}" }
+      
+      begin
+        response = open(url, headers).read
+      rescue Exception => e
+        puts "Caught exception opening #{url}"
+        puts e.message
+        puts e.backtrace.inspect
+      rescue OpenURI::HTTPError => http_e
+        puts "Received HTTP Error opening #{url}"
+        puts http_e.io.status[0].to_s
+      end
+    end
+  end
+end

data/lib/tour_cms/hash.rb

@@ -0,0 +1,8 @@
+class Hash
+  def stringify_keys
+    inject({}) do |options, (key, value)|
+      options[key.to_s] = value
+      options
+    end
+  end
+end

data/lib/tourcms.rb

@@ -0,0 +1,11 @@
+$: << File.dirname(__FILE__)
+
+require 'openssl'
+require 'base64'
+require 'cgi'
+require 'open-uri'
+require 'xml-object'
+
+require 'tour_cms/hash'
+require 'tour_cms/connection'
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tourcms'
+
+class Test::Unit::TestCase
+end

data/test/test_tourcms.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestTourcms < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification 
+name: tourcms
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alex Kremer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-26 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: xml-object
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: shoulda
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rcov
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: xml-object
+  prerelease: false
+  version_requirements: *id006
+description: A simple Ruby wrapper for interacting with the TourCMS API
+email: alex@flextrip.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/tour_cms/connection.rb
+- lib/tour_cms/hash.rb
+- lib/tourcms.rb
+- test/helper.rb
+- test/test_tourcms.rb
+has_rdoc: true
+homepage: http://github.com/flextrip/tourcms
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby Library for the TourCMS API
+test_files: 
+- test/helper.rb
+- test/test_tourcms.rb