tourcms 0.1.2 → 0.2.0

data/Gemfile

@@ -2,7 +2,7 @@ source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
 #   gem "activesupport", ">= 2.3.5"
-gem 'xml-object'
+gem 'nokogiri'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -6,10 +6,10 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    nokogiri (1.4.4)
     rake (0.8.7)
     rcov (0.9.9)
     shoulda (2.11.3)
-    xml-object (0.9.93)
 
 PLATFORMS
   ruby
@@ -17,6 +17,6 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.5.2)
+  nokogiri
   rcov
   shoulda
-  xml-object

data/README.md

@@ -12,7 +12,7 @@ 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).
+Your Marketplace ID and Private Key can be found in the TourCMS Partner Portal. The result type can be one of **hash** or **raw** where **raw** will return the raw XML from the API and **hash** will return a Ruby Hash of the result.
 
 ### Working with your connection in Raw mode
 
@@ -31,30 +31,29 @@ Your Marketplace ID and Private Key can be found in the TourCMS Partner Portal.
 	=> ""<?xml version="1.0" encoding="utf-8" ?><response><request>GET /p/channels/list.xml</request>
 		<error>OK</error><channel>(...)</channel></response>"
 
-### Working with your connection in Obj mode
+### Working with your connection in Hash mode
 
 	# Instantiate the connection
-	conn = TourCMS::Connection.new("12345", "mydeepsecret", "obj")
+	conn = TourCMS::Connection.new("12345", "mydeepsecret", "hash")
 	# 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
+	=> {:request=>"GET /api/rate_limit_status.xml", :remaining_hits=>1999, :error=>"OK", :hourly_limit=>2000}	
+	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
+	=> {Hash of all connected TourCMS channels and their properties}
+	obj[:channel].count
+	=> 100 # Integer representing how many TourCMS channels you're connected to.
+	obj[:channel].first[:channel_name]
 	=> "My Adventure Tour Operator"
 	# Show a particular channel
 	obj = conn.show_channel(1234567)
-	obj.channel.channel_id
+	obj[:channel][:channel_id]
 	=> "1234567"
 	# Search for all tours in GB
 	obj = conn.search_tours(:country => "GB")
-	obj.tour.first.tour_name
+	obj[:tour].first[:tour_name]
 	=> "Canyoning"
 	
 ### Passing parameters

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/tour_cms/connection.rb

@@ -9,67 +9,67 @@ module TourCMS
     end
     
     def api_rate_limit_status(channel = 0)
-      return_result(request("/api/rate_limit_status.xml", channel))
+      request("/api/rate_limit_status.xml", channel)
     end
     
     def list_channels
-      return_result(request("/p/channels/list.xml"))
+      request("/p/channels/list.xml")
     end
     
     def show_channel(channel)
-      return_result(request("/c/channel/show.xml", channel))
+      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))
+        request("/p/tours/search.xml", 0, params)
       else
-        return_result(request("/c/tours/search.xml", channel, params))
+        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})))
+        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})))
+        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})))
+        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})))
+        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"))
+        request("/p/tours/list.xml")
       else
-        return_result(request("/c/tours/list.xml", channel))
+        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"))
+        request("/p/tours/images/list.xml")
       else
-        return_result(request("/c/tours/images/list.xml", channel))
+        request("/c/tours/images/list.xml", channel)
       end
     end
     
     def show_tour(tour, channel)
-      return_result(request("/c/tour/show.xml", channel, {"id" => tour}))
+      request("/c/tour/show.xml", channel, {"id" => tour})
     end
     
     def show_tour_departures(tour, channel)
-      return_result(request("/c/tour/datesprices/dep/show.xml", channel, {"id" => tour}))
+      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}))
+      request("/c/tour/datesprices/freesale/show.xml", channel, {"id" => tour})
     end
     
     private
@@ -86,7 +86,7 @@ module TourCMS
       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 = param_hash.stringify.reject{|k,v| v.nil? || v.empty?}.collect{|k,v|"#{CGI.escape(k)}=#{CGI.escape(v)}"}.join("&")
         qs.empty? ? res = "" : res = "?#{qs}"
       end
       res
@@ -107,17 +107,8 @@ module TourCMS
       
       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
+            
+      @result_type == "raw" ? open(url, headers) : doc = Hash.from_xml(open(url, headers))[:response]
     end
   end
 end

data/lib/tour_cms/hash.rb

@@ -1,10 +1,67 @@
-module TourCMS
-  class Hash
-    def stringify_keys
-      inject({}) do |options, (key, value)|
-        options[key.to_s] = value.to_s
-        options
+class Hash
+  def stringify
+    inject({}) do |options, (key, value)|
+      options[key.to_s] = value.to_s
+      options
+    end
+  end
+  
+  class << self
+    def from_xml(xml_io) 
+      begin
+        result = Nokogiri::XML(xml_io)
+        return { result.root.name.to_sym => xml_node_to_hash(result.root)} 
+      rescue Exception => e
+        raise StandardError, "Could not parse TourCMS XML Response. Server error?"
       end
+    end 
+
+    def xml_node_to_hash(node) 
+      # If we are at the root of the document, start the hash 
+      if node.element?
+        result_hash = {}
+        if node.attributes != {}
+          result_hash[:attributes] = {}
+          node.attributes.keys.each do |key|
+            result_hash[:attributes][node.attributes[key].name.to_sym] = prepare(node.attributes[key].value)
+          end
+        end
+        if node.children.size > 0
+          node.children.each do |child| 
+            result = xml_node_to_hash(child) 
+
+            if child.name == "text" || child.name == "#cdata-section"
+              unless child.next_sibling || child.previous_sibling
+                return prepare(result)
+              end
+            elsif result_hash[child.name.to_sym]
+              if result_hash[child.name.to_sym].is_a?(Object::Array)
+                result_hash[child.name.to_sym] << prepare(result)
+              else
+                result_hash[child.name.to_sym] = [result_hash[child.name.to_sym]] << prepare(result)
+              end
+            else 
+              result_hash[child.name.to_sym] = prepare(result)
+            end
+          end
+
+          return result_hash 
+        else 
+          return result_hash
+        end 
+      else 
+        return prepare(node.content.to_s) 
+      end 
+    end          
+
+    def prepare(data)
+      data = "" if data == "\n\t"
+      (data.class == String && data.to_i.to_s == data) ? data.to_i : data
     end
   end
+  
+  def to_struct(struct_name)
+      Struct.new(struct_name,*keys).new(*values)
+  end
+  
 end

data/lib/tourcms.rb

@@ -4,7 +4,8 @@ require 'openssl'
 require 'base64'
 require 'cgi'
 require 'open-uri'
-require 'xml-object'
+require 'rubygems'
+require 'nokogiri'
 
 require 'tour_cms/hash'
 require 'tour_cms/connection'

data/tourcms.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tourcms}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Kremer"]
-  s.date = %q{2011-03-28}
+  s.date = %q{2011-04-19}
   s.description = %q{A simple Ruby wrapper for interacting with the TourCMS API}
   s.email = %q{alex@flextrip.com}
   s.extra_rdoc_files = [
@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/flextrip/tourcms}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.7.2}
   s.summary = %q{A Ruby Library for the TourCMS API}
   s.test_files = [
     "test/helper.rb",
@@ -41,18 +41,17 @@ Gem::Specification.new do |s|
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<xml-object>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_runtime_dependency(%q<xml-object>, [">= 0"])
     else
-      s.add_dependency(%q<xml-object>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
@@ -60,7 +59,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<xml-object>, [">= 0"])
     end
   else
-    s.add_dependency(%q<xml-object>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tourcms
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Alex Kremer
@@ -15,10 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-28 00:00:00 +02:00
-default_executable: 
+date: 2011-04-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -28,11 +28,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  name: xml-object
-  prerelease: false
   version_requirements: *id001
+  name: nokogiri
+  prerelease: false
 - !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -42,11 +42,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  version_requirements: *id002
   name: shoulda
   prerelease: false
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -58,11 +58,11 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  type: :development
+  version_requirements: *id003
   name: bundler
   prerelease: false
-  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -74,11 +74,11 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
-  type: :development
+  version_requirements: *id004
   name: jeweler
   prerelease: false
-  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -88,11 +88,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  version_requirements: *id005
   name: rcov
   prerelease: false
-  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
+  type: :runtime
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -102,10 +102,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  version_requirements: *id006
   name: xml-object
   prerelease: false
-  version_requirements: *id006
 description: A simple Ruby wrapper for interacting with the TourCMS API
 email: alex@flextrip.com
 executables: []
@@ -128,7 +127,6 @@ files:
 - test/helper.rb
 - test/test_tourcms.rb
 - tourcms.gemspec
-has_rdoc: true
 homepage: http://github.com/flextrip/tourcms
 licenses: 
 - MIT
@@ -158,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: A Ruby Library for the TourCMS API