vacation_rentals_ical_adapters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d526b9ce53b50de844cffe21affd2b2d166f9fa
+  data.tar.gz: aac604fb44bd607c8b7a9b2695abaf480a1f1bda
+SHA512:
+  metadata.gz: 1725927e2bac0ce6372c0eb73d08d2330556c56753ff10b86189c5c7b9878688c3b9693fe43ee16428bd3d572094aef299751d1c64082e3cc14b12b8575a702e
+  data.tar.gz: d3073fdb915421eaae2164e4eacdcfb9651a89924ea2e204a7f42b62ab494ede12f61a5c2f6060e26c6e83fa1045472e3d716ac2c295eaa7f293741e36e42a2f

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Karol Galanciak
+
+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,96 @@
+# VacationRentalsIcalAdapters
+
+Gem for converting different formats from various vacation rental distribution channels to iCal format. So far it handles the following adapters:
+
+- iCal adapter: returns not changed iCal body if it is indeed iCal format
+- XML Arkiane Adapter - transforms XML response from xml.arkiane.com for given property into iCal format
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vacation_rentals_ical_adapters'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vacation_rentals_ical_adapters
+
+## Usage
+
+The public API is limited to `VacationRentalsIcalAdapters::Parser#to_ical` method, here's example how to use it:
+
+``` ruby
+source = "http://xml.arkiane.com/xml_v2.asp?app=X&clt=X&top=-1&qry=to_get_planning@top_id=X,@lot_ref=X"
+arkiane_xml_body = %q{<?xml version='1.0' encoding='ISO-8859-1'?>
+<QRY-CLT1XXX-TOP-1>
+  <LINE>
+    <Planning>
+      <l_plng_no>1</l_plng_no>
+      <l_imme_no>1</l_imme_no>
+      <l_lot_no>12</l_lot_no>
+      <l_ref>XXX</l_ref>
+      <o_debut>27/08/2016</o_debut>
+      <o_fin>10/12/2016</o_fin>
+      <o_type>YYY</o_type>
+    </Planning>
+  </LINE>
+  <LINE>
+    <Planning>
+      <l_plng_no>1</l_plng_no>
+      <l_imme_no>1</l_imme_no>
+      <l_lot_no>12</l_lot_no>
+      <l_ref>XXX</l_ref>
+      <o_debut>01/11/2016</o_debut>
+      <o_fin>01/12/2016</o_fin>
+      <o_type>YYY</o_type>
+    </Planning>
+  </LINE>
+</QRY-CLT1XXX-TOP-1>}
+
+VacationRentalsIcalAdapters::Parser.to_ical(arkiane_xml_body, source: source)
+  => """
+BEGIN:VCALENDAR
+VERSION:2.0
+BEGIN:VEVENT
+DTEND;VALUE=DATE:20161210
+DTSTART;VALUE=DATE:20160827
+END:VEVENT
+BEGIN:VEVENT
+DTEND;VALUE=DATE:20161201
+DTSTART;VALUE=DATE:20161101
+END:VEVENT
+END:VCALENDAR
+"""
+```
+
+## Adding new adapters
+
+Every new adapter needs to implement `applicable?(body:, source:)` and `to_ical(body)` methods. Once you've create a new adapter, you need to register it inside `VacationRentalsIcalAdapters::Adapters` class, for example:
+
+``` ruby
+require "vacation_rentals_ical_adapters/adapters/new_awesome_adapter"
+
+register(NewAwesomeAdapter.new)
+```
+
+## 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/Azdaroth/vacation_rentals_ical_adapters.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "vacation_rentals_ical_adapters"
+
+# 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

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/lib/vacation_rentals_ical_adapters.rb

@@ -0,0 +1,5 @@
+require "vacation_rentals_ical_adapters/version"
+require "vacation_rentals_ical_adapters/parser"
+
+module VacationRentalsIcalAdapters
+end

data/lib/vacation_rentals_ical_adapters/adapters.rb

@@ -0,0 +1,25 @@
+require "vacation_rentals_ical_adapters/registry"
+
+class VacationRentalsIcalAdapters::Adapters
+  def self.adapter_for(body:, source:)
+    registry.find_adapter do |adapter|
+      adapter.applicable?(body: body, source: source)
+    end
+  end
+
+  def self.registry
+    @registry ||= VacationRentalsIcalAdapters::Registry.new
+  end
+  private_class_method :registry
+
+  def self.register(adapter)
+    registry.register(adapter)
+  end
+  private_class_method :register
+
+  require "vacation_rentals_ical_adapters/adapters/ical_adapter"
+  require "vacation_rentals_ical_adapters/adapters/xml_arkiane_adapter"
+
+  register(IcalAdapter.new) # must be first
+  register(XmlArkianeAdapter.new)
+end

data/lib/vacation_rentals_ical_adapters/adapters/ical_adapter.rb

@@ -0,0 +1,12 @@
+require "vacation_rentals_ical_adapters/adapters"
+require "icalendar"
+
+class VacationRentalsIcalAdapters::Adapters::IcalAdapter
+  def applicable?(body:, source:)
+    Icalendar::Calendar.parse(body).any?
+  end
+
+  def to_ical(body)
+    body
+  end
+end

data/lib/vacation_rentals_ical_adapters/adapters/xml_arkiane_adapter.rb

@@ -0,0 +1,36 @@
+require "active_support/core_ext/hash/conversions"
+require "vacation_rentals_ical_adapters/event"
+require "vacation_rentals_ical_adapters/ical_converter"
+
+class VacationRentalsIcalAdapters::Adapters::XmlArkianeAdapter
+  ARKIANE_XML_HOST = "xml.arkiane.com".freeze
+  private_constant :ARKIANE_XML_HOST
+
+  def applicable?(body:, source:)
+    URI(source.to_s).host == ARKIANE_XML_HOST
+  end
+
+  def to_ical(body)
+    events = parse_events(body)
+    VacationRentalsIcalAdapters::IcalConverter.to_ical(events)
+  end
+
+  private
+
+  def parse_events(body)
+    extract_availabilities(body).map do |availability|
+      VacationRentalsIcalAdapters::Event.new(
+        start_date: availability.fetch("o_debut"),
+        end_date: availability.fetch("o_fin")
+      )
+    end
+  end
+
+  def extract_availabilities(body)
+    Hash.from_xml(body)
+      .to_a
+      .flatten
+      .last["LINE"]
+      .flat_map { |el| el["Planning"] }
+  end
+end

data/lib/vacation_rentals_ical_adapters/event.rb

@@ -0,0 +1,8 @@
+class VacationRentalsIcalAdapters::Event
+  attr_reader :start_date, :end_date
+
+  def initialize(start_date:, end_date:)
+    @start_date = Date.parse(start_date)
+    @end_date = Date.parse(end_date)
+  end
+end

data/lib/vacation_rentals_ical_adapters/ical_converter.rb

@@ -0,0 +1,43 @@
+class VacationRentalsIcalAdapters::IcalConverter
+  def self.to_ical(events)
+    new(events).to_ical
+  end
+
+  attr_reader :events
+  private     :events
+
+  def initialize(events)
+    @events = events
+  end
+  private_class_method :new
+
+  def to_ical
+    [
+      ical_beginning,
+      events.map { |event| ical_event_from(event) },
+      ical_ending,
+    ].join("\n")
+  end
+
+  private
+
+  def ical_beginning
+    %Q{BEGIN:VCALENDAR
+VERSION:2.0}
+  end
+
+  def ical_event_from(event)
+%Q{BEGIN:VEVENT
+DTEND;VALUE=DATE:#{format_date(event.end_date)}
+DTSTART;VALUE=DATE:#{format_date(event.start_date)}
+END:VEVENT}
+  end
+
+  def format_date(date)
+    date.strftime("%Y%m%d")
+  end
+
+  def ical_ending
+    %Q{END:VCALENDAR}
+  end
+end

data/lib/vacation_rentals_ical_adapters/parser.rb

@@ -0,0 +1,9 @@
+require "vacation_rentals_ical_adapters/adapters"
+
+class VacationRentalsIcalAdapters::Parser
+  def self.to_ical(body, source:)
+    VacationRentalsIcalAdapters::Adapters
+      .adapter_for(body: body, source: source)
+      .to_ical(body)
+  end
+end

data/lib/vacation_rentals_ical_adapters/registry.rb

@@ -0,0 +1,28 @@
+class VacationRentalsIcalAdapters::Registry
+  attr_reader :adapters
+  private     :adapters
+
+  def initialize
+    @adapters = []
+  end
+
+  def find_adapter(&block)
+    adapters.find(adapter_not_found_proc, &block)
+  end
+
+  def register(adapter)
+    adapters << adapter
+  end
+
+  private
+
+  def adapter_not_found_proc
+    -> { raise AdapterNotFoundError }
+  end
+
+  class AdapterNotFoundError < RuntimeError
+    def message
+      "Couldn't find adapter for given :body and :source, conversion to iCal format not possible."
+    end
+  end
+end

data/lib/vacation_rentals_ical_adapters/version.rb

@@ -0,0 +1,3 @@
+module VacationRentalsIcalAdapters
+  VERSION = "0.1.0"
+end

data/vacation_rentals_ical_adapters.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vacation_rentals_ical_adapters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vacation_rentals_ical_adapters"
+  spec.version       = VacationRentalsIcalAdapters::VERSION
+  spec.authors       = ["Karol Galanciak"]
+  spec.email         = ["karol.galanciak@gmail.com"]
+
+  spec.summary       = %q{Channel-based adapters for transforming input into iCal format}
+  spec.description   = %q{Channel-based adapters for transforming input into iCal format}
+  spec.homepage      = "http://github.com/Azdaroth/decent_presenter/vacation_rentals_ical_adapters"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "coveralls"
+
+  spec.add_dependency "icalendar", "~> 2.4"
+  spec.add_dependency "activesupport", ">= 4.0"
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: vacation_rentals_ical_adapters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karol Galanciak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: icalendar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Channel-based adapters for transforming input into iCal format
+email:
+- karol.galanciak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vacation_rentals_ical_adapters.rb
+- lib/vacation_rentals_ical_adapters/adapters.rb
+- lib/vacation_rentals_ical_adapters/adapters/ical_adapter.rb
+- lib/vacation_rentals_ical_adapters/adapters/xml_arkiane_adapter.rb
+- lib/vacation_rentals_ical_adapters/event.rb
+- lib/vacation_rentals_ical_adapters/ical_converter.rb
+- lib/vacation_rentals_ical_adapters/parser.rb
+- lib/vacation_rentals_ical_adapters/registry.rb
+- lib/vacation_rentals_ical_adapters/version.rb
+- vacation_rentals_ical_adapters.gemspec
+homepage: http://github.com/Azdaroth/decent_presenter/vacation_rentals_ical_adapters
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Channel-based adapters for transforming input into iCal format
+test_files: []