beds24 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3b02a8362581d3ebed53d6b8435412849e83446cf143fbaabea7a253093422c
-  data.tar.gz: e5e5db7df54d9440f872b53ccd88d70ed1eeac63134bf2f819918572ca5a6a3f
+  metadata.gz: 516840b24ce1a38cef9407d190397c3a44c6c089b3d39e951a452325f9a46b93
+  data.tar.gz: e72470ca5cf482c9acede7e5b4f641c060004f7c567606460a85937e6f56d08c
 SHA512:
-  metadata.gz: 6a812f642b4b28d79711f812d4a9a6f237aca7a97bbb113b0dfdfc73b6e722a240d4099c5831a3cf0034cd92652d3ca5af720b5aaff8366a25680f2b09f1d3a3
-  data.tar.gz: 463ab8caa7c300ec0975e3176e7171dbbb5d5315389643c915859ae48e1d30befac11ae1e8657cf492f7297874c3e6e0220cd0824141e7c8ca6d146f54298495
+  metadata.gz: 5ea509efe8a7496f581fcecce0cb1bd295715389ff593bc0a1c40459b56180837c18fe10d547bc4833266753299553106ee0b14d6db7a9d04d5e94a14229e23e
+  data.tar.gz: 42f9b60e574ad2541c020fe94c2dc605198678ae5105c7c06e13774e6b3a133a2c08559ef1d41de1aaf57ec7036c3de8c7754aa0589f2e56331916879519c195

data/.rspec_status

@@ -0,0 +1,33 @@
+example_id                             | status | run_time        |
+-------------------------------------- | ------ | --------------- |
+./spec/beds24_spec.rb[1:1]             | passed | 0.00159 seconds |
+./spec/hash_spec.rb[1:1:1]             | passed | 0.00247 seconds |
+./spec/hash_spec.rb[1:1:2]             | passed | 0.00467 seconds |
+./spec/hash_spec.rb[1:1:3]             | passed | 0.01313 seconds |
+./spec/hash_spec.rb[1:1:4]             | passed | 0.00266 seconds |
+./spec/hash_spec.rb[1:1:5]             | passed | 0.00146 seconds |
+./spec/hash_spec.rb[1:1:6]             | passed | 0.00117 seconds |
+./spec/json_client_spec.rb[1:1:1]      | passed | 0.00014 seconds |
+./spec/json_client_spec.rb[1:2:1]      | passed | 0.00052 seconds |
+./spec/json_client_spec.rb[1:2:2]      | passed | 0.00011 seconds |
+./spec/json_client_spec.rb[1:3:1:1]    | passed | 0.01676 seconds |
+./spec/json_client_spec.rb[1:3:2:1]    | passed | 0.00161 seconds |
+./spec/json_client_spec.rb[1:4:1:1]    | passed | 0.00227 seconds |
+./spec/json_client_spec.rb[1:4:2:1]    | passed | 0.00131 seconds |
+./spec/json_client_spec.rb[1:5:1:1]    | passed | 0.00297 seconds |
+./spec/json_client_spec.rb[1:5:2:1]    | passed | 0.00236 seconds |
+./spec/xml_client_spec.rb[1:1:1]       | passed | 0.00032 seconds |
+./spec/xml_client_spec.rb[1:2:1:1]     | passed | 0.00054 seconds |
+./spec/xml_client_spec.rb[1:2:1:2]     | passed | 0.00044 seconds |
+./spec/xml_client_spec.rb[1:2:2:1]     | passed | 0.00033 seconds |
+./spec/xml_client_spec.rb[1:2:2:2]     | passed | 0.00028 seconds |
+./spec/xml_client_spec.rb[1:3:1:1:1:1] | passed | 0.00589 seconds |
+./spec/xml_client_spec.rb[1:3:1:2:1]   | passed | 0.00557 seconds |
+./spec/xml_client_spec.rb[1:3:2:1:1:1] | passed | 0.00727 seconds |
+./spec/xml_client_spec.rb[1:3:2:2:1]   | passed | 0.00511 seconds |
+./spec/xml_client_spec.rb[1:3:3:1:1:1] | passed | 0.00455 seconds |
+./spec/xml_client_spec.rb[1:3:3:2:1]   | passed | 0.00421 seconds |
+./spec/xml_request_spec.rb[1:1:1]      | passed | 0.00083 seconds |
+./spec/xml_request_spec.rb[1:1:2]      | passed | 0.00083 seconds |
+./spec/xml_request_spec.rb[1:2:1]      | passed | 0.00067 seconds |
+./spec/xml_request_spec.rb[1:2:2]      | passed | 0.00064 seconds |

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2019-10-11
+
+### Added
+
+- Added ability to list properties in JSON format
+- Added XML client to interact with XML API
+- Added ability to fetch properties through XML API
+- Added ability to fetch bookings through XML API
+- Added ability to show bookings for a property
+
+### Changed
+
+### Removed

data/README.md

@@ -1,4 +1,4 @@
-# Beds24 [![Build Status](https://travis-ci.com/mihilbabin/booking_automation.svg?branch=master)](https://travis-ci.com/mihilbabin/booking_automation) [![Gem Version](https://badge.fury.io/rb/booking_automation.svg)](https://badge.fury.io/rb/booking_automation)
+# Beds24 [![Build Status](https://travis-ci.org/mihilbabin/beds24.svg?branch=master)](https://travis-ci.org/mihilbabin/beds24) [![Gem Version](https://badge.fury.io/rb/beds24.svg)](https://badge.fury.io/rb/beds24)
 
 This is a simple wrapper of [Beds24 API](https://beds24.com/api/index.html). It allows to fetch data related to properties and bookings created and filter that data as per API docs.
 

data/lib/beds24.rb

@@ -1,6 +1,23 @@
-require "beds24/version"
+require 'httparty'
+require 'oj'
+
+require 'beds24/constants'
+require 'beds24/json_client'
+require 'beds24/version'
+require 'beds24/xml_client'
+require 'beds24/xml_request'
+
+require 'ext/hash'
 
 module Beds24
   class Error < StandardError; end
-  # Your code goes here...
+
+  class APIError < StandardError
+    attr_accessor :response
+
+    def initialize(msg, response)
+      super(msg)
+      @response = response
+    end
+  end
 end

data/lib/beds24/constants.rb

@@ -0,0 +1,30 @@
+module Beds24
+  module Constants
+    API_ROOT = 'https://beds24.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
+
+    DEFAULT_PROPERTY_OPTIONS = {
+      includeRooms: false,
+      includeRoomUnits: false,
+      includeAccountAccess: false
+    }.freeze
+
+    DEFAULT_BOOKING_OPTIONS = {
+      includeInvoice: false,
+      includeInfoItems: false
+    }.freeze
+
+    VALID_XML_BOOKING_OPTS = %i[
+      modified
+      datefrom
+      dateto
+      propid
+      roomid
+      masterid
+      bookid
+    ].freeze
+  end
+end

data/lib/beds24/json_client.rb

@@ -0,0 +1,73 @@
+module Beds24
+  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/beds24/version.rb

@@ -1,3 +1,3 @@
 module Beds24
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/beds24/xml_client.rb

@@ -0,0 +1,68 @@
+module Beds24
+  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
+
+    def modify_booking(id, attrs = {})
+      response = self.class.post('/putBookings', body: modify_payload(id, attrs))
+      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
+
+    def modify_payload(id, attrs = {})
+      payload = Nokogiri::XML(xmlize())
+      Nokogiri::XML::Builder.with(payload.at('request')) do |xml|
+        xml.bookings do
+          xml.booking(id: id, action: 'modify') do
+            attrs.each do |prop, value|
+              xml.public_send prop, value
+            end
+          end
+        end
+      end.doc.root.to_xml
+    end
+  end
+end

data/lib/beds24/xml_request.rb

@@ -0,0 +1,29 @@
+module Beds24
+  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: beds24
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michael Babin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-11 00:00:00.000000000 Z
+date: 2019-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,7 +131,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rspec_status"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -140,7 +142,12 @@ files:
 - bin/console
 - bin/setup
 - lib/beds24.rb
+- lib/beds24/constants.rb
+- lib/beds24/json_client.rb
 - lib/beds24/version.rb
+- lib/beds24/xml_client.rb
+- lib/beds24/xml_request.rb
+- lib/ext/hash.rb
 homepage: https://github.com/mihilbabin/beds24
 licenses:
 - MIT