locomotive_wubook_plugin 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c5d6c6828d7c446b2a73a2ccd4f1ffb5ff771a6
+  data.tar.gz: 78d588cbd959466f7ea3117e2fdd737cff2eef1f
+SHA512:
+  metadata.gz: a66f644a2c60f7ff058b7feb2b4e8baac005aa8f53ecedd04f8de413feeed2a4f85eb92c48ac357220ef8946b708f2cb4e49c5ca2708b0ce256000669b9ca4b0
+  data.tar.gz: 0a8e3b23488214e9a2633f35bf44af66c62a2ede2f4f24394b3b9b9977b68a33d7a145e44c5839fde0133411a1be34ce8968b0687ed6372550219ada39635cdc

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rspec',     '~> 2.12'
+gem 'mocha',     '~> 0.13'
+gem 'wubook_wired', '~> 1.0'

data/lib/locomotive/wubook/plugin/config.haml

@@ -0,0 +1,23 @@
+
+%li
+  %label{ name: 'account_code' } Account Code:
+  %input{ type: 'text', name: 'account_code' }
+
+%li
+  %label{ name: 'password' } Password:
+  %input{ type: 'password', name: 'password' }
+
+%li
+  %label{ name: 'provider_key' } Provider Key:
+  %input{ type: 'text', name: 'provider_key' }
+  %p.inline-hints Please make sure that it is exactly as provided.
+
+%li
+  %label{ name: 'lcode' } Property Identifier:
+  %input{ type: 'text', name: 'lcode' }
+  %p.inline-hints This is the lcode.
+
+%li
+  %label{ name: 'months_ahead' } Booking months ahead:
+  %input{ type: 'text', name: 'months_ahead' }
+  %p.inline-hints How many months in the future is booking allowed.

data/lib/locomotive/wubook/plugin/plugin_helper.rb

@@ -0,0 +1,29 @@
+require 'wired'
+
+module PluginHelper
+        def fetch_room_id(wired, lcode, room_id)
+                # Start with finding the room-id for the room with a special name
+                rooms = wired.fetch_rooms(lcode)
+                filtered_rooms = rooms.select { |room_hash| room_hash['shortname'] == room_id }
+                ::Locomotive.log "**> Filtered rooms #{filtered_rooms} "
+                raise "Unable to find a room with identifier: #{room_id}" if filtered_rooms.length == 0
+                room_identifier = filtered_rooms[0]['id']
+                raise "Unable to get the room id." if room_identifier == nil
+
+                room_identifier
+        end
+
+        def request_room_data(wired, lcode, room_id, startDate, endDate)
+                # Fetch availability data for given room identifier
+                room_identifier = fetch_room_id(wired, lcode, room_id)
+                # As the room id is not visible in the web interface, we have to find it first. We use the short name as identifier.
+                ::Locomotive.log "**> room_ident #{room_id}"
+
+                # Now we will request the room values. Start will be startDate with data for the next 2 years
+                room_values = wired.fetch_rooms_values(lcode, startDate, endDate, [room_identifier])
+                room_data = room_values[room_identifier.to_s]
+                raise "Missing room data from server." if room_data == nil
+
+                room_data
+        end
+end

data/lib/locomotive/wubook/plugin/version.rb

@@ -0,0 +1,6 @@
+
+module Locomotive
+  module WuBook
+    VERSION = '1.0.1'
+  end
+end

data/lib/locomotive/wubook/plugin.rb

@@ -0,0 +1,224 @@
+
+require 'rubygems'
+require 'bundler/setup'
+require 'date'
+
+require 'wired'
+require 'locomotive_plugins'
+require_relative 'plugin/plugin_helper'
+
+module Locomotive
+  module WuBook
+    class Plugin
+      include Locomotive::Plugin
+
+      def self.default_plugin_id
+        'wubook'
+      end
+
+      def initialize
+
+      end
+
+      def config_template_file
+        File.join(File.dirname(__FILE__), 'plugin', 'config.haml')
+      end
+
+      def self.liquid_tags
+        { 
+          :available => AvailableDaysBlock,
+          :checkInterval => CheckInterval,
+          :setAsBooked => SetAsBooked
+         }
+      end
+
+      protected
+
+    end
+
+    class AvailableDaysBlock < ::Liquid::Tag
+      include PluginHelper
+      def initialize(tag_name, markup, tokens, context)
+        @options = {
+          room_ident: ''
+        }
+
+        markup.scan(::Liquid::TagAttributes) { |key, value| @options[key.to_sym] = value.gsub(/"|'/, '') }
+        super
+      end
+
+      def render(context)
+        @plugin_obj = context.registers[:plugin_object]
+        config = @plugin_obj.config
+
+        returned_string = "["
+
+        # Evaluate variables and use the return of the evaluation if it exists..
+        raise "Missing parameter 'room_ident'" if @options[:room_ident].empty?
+        room_ident_evaluated = context[@options[:room_ident]]
+        @options[:room_ident] = room_ident_evaluated unless room_ident_evaluated.nil? || room_ident_evaluated.empty?
+        ::Locomotive.log "**> AvailableDaysBlock room_ident: #{@options[:room_ident]}"
+
+        today = Date.today
+        last_day = today.next_month(config['months_ahead'].to_i)
+
+        wired = Wired.new(config)
+        wired.aquire_token
+
+        room_data = request_room_data(wired, config['lcode'], @options[:room_ident], today, last_day)
+
+        # Create one entry for each day from now to then.. put a 1 if the day is available or 0 if not.
+        (today .. last_day).each_with_index do |date, i|
+          returned_string += "," if i > 0
+
+          if room_data[i] != nil && room_data[i]['avail'] === 1 
+          then
+            returned_string += "1"
+          else
+            returned_string += "0"  
+          end
+        end
+
+        wired.release_token
+
+        returned_string + "]"
+      end
+
+      def render_disabled(context)
+        "[]"
+      end
+    end
+
+    class CheckInterval < ::Liquid::Tag
+      include PluginHelper
+      def initialize(tag_name, markup, tokens, context)
+        @options = {
+          room_ident: '',
+          date_start: '',
+          date_end: ''
+        }
+
+        markup.scan(::Liquid::TagAttributes) { |key, value| @options[key.to_sym] = value.gsub(/"|'/, '') }
+        super
+      end
+
+      def render(context)
+        @plugin_obj = context.registers[:plugin_object]
+        config = @plugin_obj.config
+
+        # Evaluate variables and use the return of the evaluation if it exists..
+        raise "Missing parameter 'room_ident'" if @options[:room_ident].empty?
+        room_ident_evaluated = context[@options[:room_ident]]
+        @options[:room_ident] = room_ident_evaluated unless room_ident_evaluated.nil? || room_ident_evaluated.empty?
+        ::Locomotive.log "**> CheckInterval room_ident: #{@options[:room_ident]}"
+
+        raise "Missing parameter 'date_start'" if @options[:date_start].empty?
+        date_start_evaluated = context[@options[:date_start]]
+        @options[:date_start] = date_start_evaluated unless date_start_evaluated.nil?
+        ::Locomotive.log "**> CheckInterval date_start_evaluated: #{@options[:date_start]}"
+
+        raise "Missing parameter 'date_end'" if @options[:date_end].empty?
+        date_end_evaluated = context[@options[:date_end]]
+        @options[:date_end] = date_end_evaluated unless date_end_evaluated.nil?
+        ::Locomotive.log "**> CheckInterval date_end: #{@options[:date_end]}"
+
+        start_day = @options[:date_start]
+        last_day  = @options[:date_end]
+        ::Locomotive.log "**> CheckInterval: Date Interval: #{start_day} - #{last_day}"
+
+        wired = Wired.new(config)
+        wired.aquire_token
+        room_data = request_room_data(wired, config['lcode'], @options[:room_ident], start_day, last_day)
+        wired.release_token
+
+        # Check whether first day is available. If this is _not_ the case we have to add one day (vacation == departure is allowed)
+        is_first_available = room_data[0]['avail'] === 1
+
+        # Check wheter the last day is not available. If this is _not_ the case we have to reduce one day (vacation == departure is allowed)
+        is_last_available = room_data[last_day.mjd - start_day.mjd]['avail'] === 1
+
+        # Remove the first or last day from the array.
+        room_data.shift  unless is_first_available # Remove first element
+        room_data[0..-1] unless is_last_available  # Remove last element
+
+        # Now check the (modified) interval regarding availability
+        is_available = true
+        room_data.each do |data|
+          ::Locomotive.log "**> CheckInterval: check: #{data}"
+          if data['avail'] === 0 then
+            is_available = false;
+            break
+          end
+        end
+
+        is_available ? "Ok" : "Err"
+      end
+
+      def render_disabled(context)
+        "Ok"
+      end
+    end
+
+    # This tag sets the availability of the given days to 0 (false)
+    class SetAsBooked < ::Liquid::Tag
+      include PluginHelper
+      def initialize(tag_name, markup, tokens, context)
+        @options = {
+          room_ident: '',
+          date_start: '',
+          date_end: ''
+        }
+
+        markup.scan(::Liquid::TagAttributes) { |key, value| @options[key.to_sym] = value.gsub(/"|'/, '') }
+        super
+      end
+
+      def render(context)
+        @plugin_obj = context.registers[:plugin_object]
+        config = @plugin_obj.config
+
+        raise "Missing parameter 'room_ident'" if @options[:room_ident].empty?
+        room_ident_evaluated = context[@options[:room_ident]]
+        @options[:room_ident] = room_ident_evaluated unless room_ident_evaluated.nil? || room_ident_evaluated.empty?
+        ::Locomotive.log "**> SetAsBooked room_ident: #{@options[:room_ident]}"
+
+        raise "Missing parameter 'date_start'" if @options[:date_start].empty?
+        date_start_evaluated = context[@options[:date_start]]
+        @options[:date_start] = date_start_evaluated unless date_start_evaluated.nil?
+        ::Locomotive.log "**> SetAsBooked date_start_evaluated: #{@options[:date_start_evaluated]}"
+
+        raise "Missing parameter 'date_end'" if @options[:date_end].empty?
+        date_end_evaluated = context[@options[:date_end]]
+        @options[:date_end] = date_end_evaluated unless date_end_evaluated.nil?
+        ::Locomotive.log "**> SetAsBooked date_end: #{@options[:date_end]}"
+
+        start_day = @options[:date_start]
+        last_day  = @options[:date_end]
+        ::Locomotive.log "**> SetAsBooked: Date Interval: #{start_day} - #{last_day}"
+
+        wired = Wired.new(config)
+        wired.aquire_token
+        room_id = fetch_room_id(wired, config['lcode'], @options[:room_ident])
+
+        # Set availability for given date interval to 0
+        days = []
+        (start_day .. last_day).each do |date|
+          # Ignore date.. I will just iterate over every day..
+          days.push({ 'avail' => 0 })
+        end
+        avail_data = [ {'id' => room_id, 'days' => days} ]
+        ::Locomotive.log "**> SetAsBooked: Set avail to 0 for: #{start_day}: #{avail_data}"
+        wired.update_rooms_values(config['lcode'], start_day, avail_data)
+
+        wired.release_token
+
+        # Return a html comment that shows us that everything is fine.
+        "<!-- Availability was set to 0 for room #{@options[:room_ident]} from #{@options[:date_start]} to #{@options[:date_end]} -->"
+      end
+
+      def render_disabled(context)
+        "<!-- Locomotive_wubook_plugin is disabled! -->"
+      end
+    end
+  end
+end

data/lib/locomotive/wubook/plugin.rb.orig

@@ -0,0 +1,194 @@
+
+require 'rubygems'
+require 'bundler/setup'
+require 'date'
+
+require 'wired'
+require 'locomotive_plugins'
+
+module Locomotive
+  module WuBook
+    class Plugin
+      include Locomotive::Plugin
+
+      def self.default_plugin_id
+        'wubook'
+      end
+
+      def initialize
+
+      end
+
+      def config_template_file
+        File.join(File.dirname(__FILE__), 'plugin', 'config.haml')
+      end
+
+      def self.liquid_tags
+        { :available => AvailableDaysBlock }
+      end
+
+      protected
+
+    end
+
+    class AvailableDaysBlock < ::Liquid::Tag
+      def initialize(tag_name, markup, tokens, context)
+        @options = {
+          room_ident: ''
+        }
+
+        markup.scan(::Liquid::TagAttributes) { |key, value| @options[key.to_sym] = value.gsub(/"|'/, '') }
+        super
+      end
+
+      def render(context)
+        @plugin_obj = context.registers[:plugin_object]
+        config = @plugin_obj.config
+
+        returned_string = "["
+
+        raise "Missing parameter 'room_ident'" if @options[:room_ident].empty?
+
+        # Fetch availability data for given room identifier
+        # As the room id is not visible in the web interface, we have to find it first. We use the short name as identifier.
+        wired = Wired.new(config)
+        wired.aquire_token
+
+        # Start with finding the room-id for the room with a special name
+        rooms = wired.fetch_rooms(config['lcode'])
+        filtered_rooms = rooms.select { |room_hash| room_hash['shortname'].casecmp @options['room_ident'.to_sym] }
+        raise "Unable to find a room with identifier: #{@options['room_ident']}" if filtered_rooms.length == 0
+        room_identifier = filtered_rooms[0]['id']
+        raise "Unable to get the room id." if room_identifier == nil
+
+        # Now we will request the room values. Start will be today with data for the next 2 years
+        today = Date.today
+        last_day = today.next_month(config['months_ahead'].to_i)
+        room_values = wired.fetch_rooms_values(config['lcode'], today, last_day, [room_identifier])
+        room_data = room_values[room_identifier.to_s]
+        raise "Missing room data from server." if room_data == nil
+
+        # Create one entry for each day from now to then.. put a 1 if the day is available or 0 if not.
+        (today .. last_day).each_with_index do |date, i|
+          returned_string += "," if i > 0
+
+          if room_data[i] != nil && room_data[i]['avail'] === 1 
+          then
+            returned_string += "1"
+          else
+            returned_string += "0"  
+          end
+        end
+
+        wired.release_token
+
+        returned_string + "]"
+      end
+    end
+<<<<<<< HEAD
+=======
+
+    class CheckInterval < ::Liquid::Tag
+      include PluginHelper
+      def initialize(tag_name, markup, tokens, context)
+        @options = {
+          room_ident: '',
+          date_start: '',
+          date_end: ''
+        }
+
+        markup.scan(::Liquid::TagAttributes) { |key, value| @options[key.to_sym] = value.gsub(/"|'/, '') }
+        super
+      end
+
+      def render(context)
+        @plugin_obj = context.registers[:plugin_object]
+        config = @plugin_obj.config
+
+        raise "Missing parameter 'room_ident'" if @options[:room_ident].empty?
+        raise "Missing parameter 'date_start'" if @options[:date_start].empty?
+        raise "Missing parameter 'date_end'" if @options[:date_end].empty?
+
+        start_day = Date.strptime(@options[:date_start], '%d.%m.%Y')
+        last_day  = Date.strptime(@options[:date_end], '%d.%m.%Y')
+        ::Locomotive.log "**> CheckInterval: Date Interval: #{start_day} - #{last_day}"
+
+        wired = Wired.new(config)
+        wired.aquire_token
+        room_data = request_room_data(wired, config['lcode'], @options[:room_ident], start_day, last_day)
+        wired.release_token
+
+        # Check whether first day is available. If this is _not_ the case we have to add one day (vacation == departure is allowed)
+        is_first_available = room_data[0]['avail'] === 1
+
+        # Check wheter the last day is not available. If this is _not_ the case we have to reduce one day (vacation == departure is allowed)
+        is_last_available = room_data[last_day.mjd - start_day.mjd]['avail'] === 1
+
+        # Remove the first or last day from the array.
+        room_data.shift  unless is_first_available # Remove first element
+        room_data[0..-1] unless is_last_available  # Remove last element
+
+        # Now check the (modified) interval regarding availability
+        is_available = true
+        room_data.each do |data|
+          ::Locomotive.log "**> CheckInterval: check: #{data}"
+          if data['avail'] === 0 then
+            is_available = false;
+            break
+          end
+        end
+
+        is_available ? "Ok" : "Err"
+      end
+    end
+
+    # This tag sets the availability of the given days to 0 (false)
+    class SetAsBooked < ::Liquid::Tag
+      include PluginHelper
+      def initialize(tag_name, markup, tokens, context)
+        @options = {
+          room_ident: '',
+          date_start: '',
+          date_end: ''
+        }
+
+        markup.scan(::Liquid::TagAttributes) { |key, value| @options[key.to_sym] = value.gsub(/"|'/, '') }
+        super
+      end
+
+      def render(context)
+        @plugin_obj = context.registers[:plugin_object]
+        config = @plugin_obj.config
+
+        raise "Missing parameter 'room_ident'" if @options[:room_ident].empty?
+        raise "Missing parameter 'date_start'" if @options[:date_start].empty?
+        raise "Missing parameter 'date_end'" if @options[:date_end].empty?
+
+        start_day = Date.strptime(@options[:date_start], '%d.%m.%Y')
+        last_day  = Date.strptime(@options[:date_end], '%d.%m.%Y')
+        ::Locomotive.log "**> SetAsBooked: Date Interval: #{start_day} - #{last_day}"
+
+        wired = Wired.new(config)
+        wired.aquire_token
+        room_id = fetch_room_id(wired, config['lcode'], @options[:room_ident])
+
+        # Set availability for given date interval to 0
+        days = []
+        (start_day .. last_day).each do |date|
+          # Ignore date.. I will just iterate over every day..
+          days.push({ 'avail' => 0 })
+        end
+        avail_data = [ {'id' => room_id, 'days' => days} ]
+        ::Locomotive.log "**> SetAsBooked: Set avail to 0 for: #{start_day}: #{avail_data}"
+        wired.update_rooms_values(config['lcode'], start_day, avail_data)
+
+        wired.release_token
+
+        # Return a html comment that shows us that everything is fine.
+        "<!-- Availability was set to 0 for room #{@options[:room_ident]} from #{@options[:date_start]} to #{@options[:date_end]} -->"
+      end
+
+    end
+>>>>>>> 06db809... ddd
+  end
+end

data/lib/locomotive_wubook_plugin.rb

@@ -0,0 +1 @@
+require 'locomotive/wubook/plugin'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: locomotive_wubook_plugin
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Stefan Eilers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: locomotive_plugins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: wubook_wired
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Locomotive plugin for accessing WuBook.net channel manager
+email: se@intelligentmobiles.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- lib/locomotive/wubook/plugin.rb
+- lib/locomotive/wubook/plugin.rb.orig
+- lib/locomotive/wubook/plugin/config.haml
+- lib/locomotive/wubook/plugin/plugin_helper.rb
+- lib/locomotive/wubook/plugin/version.rb
+- lib/locomotive_wubook_plugin.rb
+homepage: https://github.com/eilers/locomotive_wubook_plugin
+licenses:
+- Private
+metadata: {}
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Integrates some of the WuBooks 'Wired' interface.
+test_files: []