booking_automation 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 962b6d00aed91c3195ac3eca6690483ad716eea307f814cc717cc47a4cf0a24d
+  data.tar.gz: 18639908b04ab01a4a932bec46f24d5e3aebb0bfb522eb22cb57b85aa3fe80d7
+SHA512:
+  metadata.gz: 96c8b7f5a36860ad3a3cbf4835d5e25ade66ada5c57613c33950a2e6d56beadfbb6164bddec7e7efc150c3128a0caef1861b5aaf91d7cb6f6c9edd5f86ea187d
+  data.tar.gz: 4d9f8228baae4101dd209889d5a1949adbf593ab1d16224f43ebeb067f997d7bed4510634b1ef9829f5b84e29c6c61fd034b4a31a5af5348c19e3e0c311cc913

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rspec_status

@@ -0,0 +1,12 @@
+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 |

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1
+script: bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# 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-06-30
+
+### Added
+
+- Added ability to list properties
+- Added ability to fetch individual property
+- Added ability to show bookings for a property
+
+### Changed
+
+### Removed

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in booking_automation.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Michael Babin
+
+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,56 @@
+# BookingAutomation [![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)
+
+This is a simple wrapper of [BookingAutomation API](https://manage.bookingautomation.com/api/index.html). It allows to fetch data related to properties and bookings created and filter that data as per API docs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'booking_automation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install booking_automation
+
+## Usage
+
+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
+
+```ruby
+auth_token = '<your-key>'
+client = BookingAutomation::Client.new auth_token
+
+client.get_properties # List all account properties
+
+prop_key = '<property-key>'
+
+client.get_property(prop_key) # Display individual property data
+client.get_property(prop_key, includeRooms: true) # Pass parameters as per docs
+
+client.get_bookings(prop_key) # Get all bookings for given property
+client.get_bookings(prop_key, includeInvoice: true) # Pass parameters as per docs
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mihilbabin/booking_automation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'booking_automation'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/booking_automation.gemspec

@@ -0,0 +1,47 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'booking_automation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'booking_automation'
+  spec.version       = BookingAutomation::VERSION
+  spec.authors       = ['Michael Babin']
+  spec.email         = ['michaelbabin.eu@gmail.com']
+
+  spec.summary       = %q{Booking Automation API}
+  spec.description   = %q{Bindings for BookingAutomation.com API}
+  spec.homepage      = 'https://github.com/mihilbabin/booking_automation'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.md"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Development dependencies
+  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 'webmock', '~> 3.6'
+
+  # Dependencies
+  spec.add_dependency 'httparty', '~> 0.17.0'
+  spec.add_dependency 'oj', '~> 3.7'
+end

data/lib/booking_automation/constants.rb

@@ -0,0 +1,18 @@
+module BookingAutomation
+  module Constants
+    API_ENDPOINT = 'https://manage.bookingautomation.com/api/json'.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
+  end
+end

data/lib/booking_automation/version.rb

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

data/lib/booking_automation.rb

@@ -0,0 +1,89 @@
+require 'httparty'
+require 'oj'
+require 'booking_automation/constants'
+require 'booking_automation/version'
+
+module BookingAutomation
+  class Error < StandardError; end
+
+  class APIError < StandardError
+    attr_accessor :response
+
+    def initialize(msg, response)
+      super(msg)
+      @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

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: booking_automation
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Michael Babin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Bindings for BookingAutomation.com API
+email:
+- michaelbabin.eu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rspec_status"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- booking_automation.gemspec
+- lib/booking_automation.rb
+- lib/booking_automation/constants.rb
+- lib/booking_automation/version.rb
+homepage: https://github.com/mihilbabin/booking_automation
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mihilbabin/booking_automation
+  source_code_uri: https://github.com/mihilbabin/booking_automation
+  changelog_uri: https://github.com/mihilbabin/booking_automation/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Booking Automation API
+test_files: []