booking_automation 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 962b6d00aed91c3195ac3eca6690483ad716eea307f814cc717cc47a4cf0a24d
-  data.tar.gz: 18639908b04ab01a4a932bec46f24d5e3aebb0bfb522eb22cb57b85aa3fe80d7
+  metadata.gz: c3ede7f0ff6fb912ecb43017c225b107aa6080a839b0385a979c60673c446485
+  data.tar.gz: 96ef7a0a0ed5d3c8d4c78ab64ef899f1e2e6f3d1585061bb53254d4a5b812ba9
 SHA512:
-  metadata.gz: 96c8b7f5a36860ad3a3cbf4835d5e25ade66ada5c57613c33950a2e6d56beadfbb6164bddec7e7efc150c3128a0caef1861b5aaf91d7cb6f6c9edd5f86ea187d
-  data.tar.gz: 4d9f8228baae4101dd209889d5a1949adbf593ab1d16224f43ebeb067f997d7bed4510634b1ef9829f5b84e29c6c61fd034b4a31a5af5348c19e3e0c311cc913
+  metadata.gz: 1793390cd537f4c8be2d3f6c0c5247c1c0128254dc9fb4ccc5373481fdeb24c506d2f744fce2d2fecec724415c3d7201b03f98c631400e5168fb300c9f2d1d64
+  data.tar.gz: bee3dbe0ae2e2ec4b66359139bffbf804958374775a1c6efb80ca1bd1cefe37a6474e4868871d938a91000693052b30a692a2f4f3cbb18ebcfea106743b31102

data/.rspec_status

@@ -1,12 +1,31 @@
-example_id                                        | status | run_time        |
-------------------------------------------------- | ------ | --------------- |
-./spec/booking_automation_client_spec.rb[1:1:1]   | passed | 0.00062 seconds |
-./spec/booking_automation_client_spec.rb[1:2:1]   | passed | 0.00023 seconds |
-./spec/booking_automation_client_spec.rb[1:2:2]   | passed | 0.00007 seconds |
-./spec/booking_automation_client_spec.rb[1:3:1:1] | passed | 0.00544 seconds |
-./spec/booking_automation_client_spec.rb[1:3:2:1] | passed | 0.0008 seconds  |
-./spec/booking_automation_client_spec.rb[1:4:1:1] | passed | 0.00113 seconds |
-./spec/booking_automation_client_spec.rb[1:4:2:1] | passed | 0.00076 seconds |
-./spec/booking_automation_client_spec.rb[1:5:1:1] | passed | 0.00111 seconds |
-./spec/booking_automation_client_spec.rb[1:5:2:1] | passed | 0.00081 seconds |
-./spec/booking_automation_spec.rb[1:1]            | passed | 0.00037 seconds |
+example_id                             | status | run_time        |
+-------------------------------------- | ------ | --------------- |
+./spec/booking_automation_spec.rb[1:1] | passed | 0.00033 seconds |
+./spec/hash_spec.rb[1:1:1]             | passed | 0.00053 seconds |
+./spec/hash_spec.rb[1:1:2]             | passed | 0.00133 seconds |
+./spec/hash_spec.rb[1:1:3]             | passed | 0.00058 seconds |
+./spec/hash_spec.rb[1:1:4]             | passed | 0.0012 seconds  |
+./spec/hash_spec.rb[1:1:5]             | passed | 0.0005 seconds  |
+./spec/hash_spec.rb[1:1:6]             | passed | 0.00063 seconds |
+./spec/json_client_spec.rb[1:1:1]      | passed | 0.00007 seconds |
+./spec/json_client_spec.rb[1:2:1]      | passed | 0.00027 seconds |
+./spec/json_client_spec.rb[1:2:2]      | passed | 0.00006 seconds |
+./spec/json_client_spec.rb[1:3:1:1]    | passed | 0.00533 seconds |
+./spec/json_client_spec.rb[1:3:2:1]    | passed | 0.00082 seconds |
+./spec/json_client_spec.rb[1:4:1:1]    | passed | 0.00122 seconds |
+./spec/json_client_spec.rb[1:4:2:1]    | passed | 0.00075 seconds |
+./spec/json_client_spec.rb[1:5:1:1]    | passed | 0.0012 seconds  |
+./spec/json_client_spec.rb[1:5:2:1]    | passed | 0.00084 seconds |
+./spec/xml_client_spec.rb[1:1:1]       | passed | 0.00008 seconds |
+./spec/xml_client_spec.rb[1:2:1:1]     | passed | 0.00006 seconds |
+./spec/xml_client_spec.rb[1:2:1:2]     | passed | 0.00006 seconds |
+./spec/xml_client_spec.rb[1:2:2:1]     | passed | 0.00005 seconds |
+./spec/xml_client_spec.rb[1:2:2:2]     | passed | 0.00005 seconds |
+./spec/xml_client_spec.rb[1:3:1:1:1:1] | passed | 0.00254 seconds |
+./spec/xml_client_spec.rb[1:3:1:2:1]   | passed | 0.00243 seconds |
+./spec/xml_client_spec.rb[1:3:2:1:1:1] | passed | 0.00176 seconds |
+./spec/xml_client_spec.rb[1:3:2:2:1]   | passed | 0.00143 seconds |
+./spec/xml_request_spec.rb[1:1:1]      | passed | 0.00015 seconds |
+./spec/xml_request_spec.rb[1:1:2]      | passed | 0.00014 seconds |
+./spec/xml_request_spec.rb[1:2:1]      | passed | 0.00015 seconds |
+./spec/xml_request_spec.rb[1:2:2]      | passed | 0.00013 seconds |

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2019-08-04
+
+### Added
+
+- Added XML client to interact with XML API
+- Added ability to fetch properties through XML API
+- Added ability to fetch bookings through XML API
+
+### Changed
+
+- Renamed Client to JSONClient
+
 ## [0.1.0] - 2019-06-30
 
 ### Added

data/README.md

@@ -24,11 +24,11 @@ To use a gem you should allow API Key through your BookingAutomation settings.
 Wrapper needs you to supply the account API key (auth_token) set at the menu "Settings > Account"
 Operations involving a specific property need to supply the property key (propKey) set at the menu "Settings > Properties > Link"
 
-### Sample Code
+### Sample Code for JSON API
 
 ```ruby
 auth_token = '<your-key>'
-client = BookingAutomation::Client.new auth_token
+client = BookingAutomation::JSONClient.new auth_token
 
 client.get_properties # List all account properties
 
@@ -41,6 +41,46 @@ client.get_bookings(prop_key) # Get all bookings for given property
 client.get_bookings(prop_key, includeInvoice: true) # Pass parameters as per docs
 ```
 
+### Sample Code for XML API
+
+```ruby
+username = '<your-username>'
+password = '<your-password>'
+client = BookingAutomation::XMLClient.new username, password
+
+client.get_properties # List all account properties
+
+client.get_properties(propid: 123) # Display individual property data
+
+client.get_bookings() # Get all bookings
+client.get_bookings(propid: 123, datefrom: '20190101') # Pass parameters as per docs
+```
+
+Data returned is already parsed in a meaningful way to plain Ruby `Hash`.
+IDs and names are extracted to a top level to avoid hash keys collision.
+Attributes are also preserved.
+
+Example:
+
+```xml
+<bookings attr="test">
+    <booking id="1"><!-- DATA --></booking>
+    <booking id="2"><!-- DATA --></booking>
+</bookings>
+```
+
+will become:
+
+```ruby
+{
+    'bookings' => {
+        'attr' => 'test',
+        '1' => {...},
+        '2' => {...}
+    }
+}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/booking_automation.gemspec

@@ -39,9 +39,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.17.0'
   spec.add_development_dependency 'webmock', '~> 3.6'
 
   # Dependencies
   spec.add_dependency 'httparty', '~> 0.17.0'
+  spec.add_dependency 'nokogiri', '~> 1.10'
   spec.add_dependency 'oj', '~> 3.7'
 end

data/lib/booking_automation.rb

@@ -1,7 +1,13 @@
 require 'httparty'
 require 'oj'
+
 require 'booking_automation/constants'
+require 'booking_automation/json_client'
 require 'booking_automation/version'
+require 'booking_automation/xml_client'
+require 'booking_automation/xml_request'
+
+require 'ext/hash'
 
 module BookingAutomation
   class Error < StandardError; end
@@ -14,76 +20,4 @@ module BookingAutomation
       @response = response
     end
   end
-
-  class Client
-    include HTTParty
-    base_uri Constants::API_ENDPOINT
-
-    attr_accessor :auth_token
-
-    def initialize(auth_token)
-      @auth_token = auth_token
-    end
-
-    def get_properties
-      response = self.class.post('/getProperties', body: authentication.to_json)
-      json = parse! response
-      json['getProperties']
-    rescue Oj::ParseError
-      raise Error, Constants::PARSE_ERROR_MSG
-    rescue APIError => e
-      e.response
-    end
-
-    def get_property(prop_key, options={})
-      response = self.class.post(
-        '/getProperty',
-        body: payload(prop_key, Constants::DEFAULT_PROPERTY_OPTIONS.merge(options))
-      )
-      json = parse! response
-      json['getProperty'].first
-    rescue Oj::ParseError
-      raise Error, Constants::PARSE_ERROR_MSG
-    rescue APIError => e
-      e.response
-    end
-
-    def get_bookings(prop_key, options={})
-      response = self.class.post(
-        '/getBookings',
-        body: payload(prop_key, Constants::DEFAULT_BOOKING_OPTIONS.merge(options))
-      )
-      parse! response
-    rescue Oj::ParseError
-      raise Error, Constants::PARSE_ERROR_MSG
-    rescue APIError => e
-      e.response
-    end
-
-    private
-
-    def authentication(prop_key=nil)
-      {
-        authentication: {
-          apiKey: auth_token,
-          propKey: prop_key
-        }
-      }
-    end
-
-    def payload(prop_key=nil, options={})
-      authentication(prop_key)
-        .merge(options)
-        .to_json
-    end
-
-    def parse!(response)
-      json = Oj.load response.body
-      raise APIError.new(
-        "API Error: #{json['errorCode']} #{json['error']}",
-        json
-       ) if json.is_a?(Hash) && !json['error'].nil?
-      json
-    end
-  end
 end

data/lib/booking_automation/constants.rb

@@ -1,6 +1,8 @@
 module BookingAutomation
   module Constants
-    API_ENDPOINT = 'https://manage.bookingautomation.com/api/json'.freeze
+    API_ROOT = 'https://manage.bookingautomation.com/api'.freeze
+    JSON_API_ENDPOINT = "#{API_ROOT}/json".freeze
+    XML_API_ENDPOINT = "#{API_ROOT}/xml".freeze
 
     PARSE_ERROR_MSG = 'Got encoding different from JSON. Please check passed options'.freeze
 
@@ -14,5 +16,15 @@ module BookingAutomation
       includeInvoice: false,
       includeInfoItems: false
     }.freeze
+
+    VALID_XML_BOOKING_OPTS = %i[
+      modified
+      datefrom
+      dateto
+      propid
+      roomid
+      masterid
+      bookid
+    ].freeze
   end
 end

data/lib/booking_automation/json_client.rb

@@ -0,0 +1,73 @@
+module BookingAutomation
+  class JSONClient
+    include HTTParty
+    base_uri Constants::JSON_API_ENDPOINT
+
+    attr_accessor :auth_token
+
+    def initialize(auth_token)
+      @auth_token = auth_token
+    end
+
+    def get_properties
+      response = self.class.post('/getProperties', body: authentication.to_json)
+      json = parse! response
+      json['getProperties']
+    rescue Oj::ParseError
+      raise Error, Constants::PARSE_ERROR_MSG
+    rescue APIError => e
+      e.response
+    end
+
+    def get_property(prop_key, options={})
+      response = self.class.post(
+        '/getProperty',
+        body: payload(prop_key, Constants::DEFAULT_PROPERTY_OPTIONS.merge(options))
+      )
+      json = parse! response
+      json['getProperty'].first
+    rescue Oj::ParseError
+      raise Error, Constants::PARSE_ERROR_MSG
+    rescue APIError => e
+      e.response
+    end
+
+    def get_bookings(prop_key, options={})
+      response = self.class.post(
+        '/getBookings',
+        body: payload(prop_key, Constants::DEFAULT_BOOKING_OPTIONS.merge(options))
+      )
+      parse! response
+    rescue Oj::ParseError
+      raise Error, Constants::PARSE_ERROR_MSG
+    rescue APIError => e
+      e.response
+    end
+
+    private
+
+    def authentication(prop_key=nil)
+      {
+        authentication: {
+          apiKey: auth_token,
+          propKey: prop_key
+        }
+      }
+    end
+
+    def payload(prop_key=nil, options={})
+      authentication(prop_key)
+        .merge(options)
+        .to_json
+    end
+
+    def parse!(response)
+      json = Oj.load response.body
+      raise APIError.new(
+        "API Error: #{json['errorCode']} #{json['error']}",
+        json
+      ) if json.is_a?(Hash) && !json['error'].nil?
+      json
+    end
+  end
+end

data/lib/booking_automation/version.rb

@@ -1,3 +1,3 @@
 module BookingAutomation
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/booking_automation/xml_client.rb

@@ -0,0 +1,48 @@
+module BookingAutomation
+  class XMLClient
+    include HTTParty
+    base_uri Constants::XML_API_ENDPOINT
+    headers 'Content-Type' => 'text/xml'
+
+    attr_accessor :username, :password
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+    end
+
+    def get_properties(opts = {})
+      response = self.class.post('/getProperties', body: xmlize(opts.slice(:propid)))
+      parse! response
+    rescue APIError => e
+      e.response
+    end
+
+    def get_bookings(opts = {})
+      valid_opts = opts.slice(*Constants::VALID_XML_BOOKING_OPTS)
+      response = self.class.post('/getBookings', body: xmlize(valid_opts))
+      parse! response
+    rescue APIError => e
+      e.response
+    end
+
+    private
+
+    def parse!(response)
+      hash = Hash.from_xml(response.body)
+      raise APIError.new(
+        "API Error: #{hash['code']} #{hash['error']}",
+        hash
+      ) if hash.key?('error')
+      hash
+    end
+
+    def auth
+      { username: @username, password: @password }
+    end
+
+    def xmlize(opts = {})
+      XMLRequest.new(auth, opts).to_xml
+    end
+  end
+end

data/lib/booking_automation/xml_request.rb

@@ -0,0 +1,29 @@
+module BookingAutomation
+  class XMLRequest
+    def initialize(auth, opts = {})
+      @auth = auth
+      @opts = opts
+    end
+
+    def to_xml
+      data = builder.new do |xml|
+        xml.request do
+          xml.auth do
+            xml.username @auth[:username]
+            xml.password @auth[:password]
+          end
+          @opts.each do |prop, value|
+            xml.public_send prop, value
+          end
+        end
+      end
+      data.doc.root.to_xml
+    end
+
+    private
+
+    def builder
+      Nokogiri::XML::Builder
+    end
+  end
+end

data/lib/ext/hash.rb

@@ -0,0 +1,56 @@
+require 'nokogiri'
+
+class Hash
+  class << self
+    def from_xml(xml_io)
+      result = Nokogiri::XML(xml_io)
+      { result.root.name => xml_node_to_hash(result.root)}
+    end
+
+    def xml_node_to_hash(node)
+      if node.element?
+        result_hash = {}
+        if node.attributes != {}
+          attributes = {}
+          node.attributes.keys.each do |key|
+            if [:id, 'id', :name, 'name'].include?(key)
+              node.name = node.attributes[key].value
+              node.delete(key.to_s)
+            else
+              attributes[node.attributes[key].name] = node.attributes[key].value
+            end
+          end
+        end
+
+        if node.children.size > 0
+          node.children.each do |child|
+            result = xml_node_to_hash(child)
+
+            if child.name == 'text'
+              unless child.next_sibling || child.previous_sibling
+                return result unless attributes
+                result_hash[child.name] = result
+              end
+            elsif result_hash[child.name]
+              if result_hash[child.name].is_a?(Array)
+                 result_hash[child.name] << result
+              else
+                 result_hash[child.name] = [result_hash[child.name]] << result
+              end
+            else
+              result_hash[child.name] = result
+            end
+          end
+          if attributes
+            result_hash = attributes.merge(result_hash)
+          end
+          return result_hash
+        else
+          return attributes
+        end
+      else
+        node.content.to_s
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: booking_automation
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Babin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-30 00:00:00.000000000 Z
+date: 2019-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -115,7 +143,11 @@ files:
 - booking_automation.gemspec
 - lib/booking_automation.rb
 - lib/booking_automation/constants.rb
+- lib/booking_automation/json_client.rb
 - lib/booking_automation/version.rb
+- lib/booking_automation/xml_client.rb
+- lib/booking_automation/xml_request.rb
+- lib/ext/hash.rb
 homepage: https://github.com/mihilbabin/booking_automation
 licenses:
 - MIT