kigo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 896128c548ca3f06e03ba17a5dabfdca9b78be99
+  data.tar.gz: 5a9bb28d0ce254bf634eb6ca2ca0b695b648e907
+SHA512:
+  metadata.gz: 69135bf59c410516953754a37c4ddd686387aa341d40872c4c584d83b05cfa50b3ec595fe90fd37d1538ad504e11da6a1deeaf11e70cf51483c6b2db8face112
+  data.tar.gz: cc2bc838c594616533f760a33059d142d03c60c59794cbcae332fecc3b7f9d8f54a6fbc6d75671030994efd88289e30895a9dc5851fc743d586e84798254e5c0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rijaludin Muhsin
+
+MIT License
+
+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,45 @@
+# Kigo
+
+Kigo is an online vacation rental software. http://kigo.net
+
+They also provide their services to be accessed via API. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kigo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kigo
+
+## Configuration
+
+Add an initializer e.g config/initializers/kigo.rb
+
+You will get the username and password once you register.
+
+```ruby
+Kigo.configure do |config|
+  config.username = 'your username'
+  config.password = 'your password'
+end
+```
+
+## Usage
+
+NOTE: Still in development
+
+Basically to use the gem is to call the API service name in underscore.
+
+For example when you want to access /diffPropertyCalendarReservations you can use:
+
+```ruby
+diff_id = "diff id string"
+Kigo.diff_property_calendar_reservations diff_id
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/kigo.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kigo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kigo"
+  spec.version       = Kigo::VERSION
+  spec.authors       = ["Rijaludin Muhsin"]
+  spec.email         = ["rijaludinmuhsin@gmail.com"]
+  spec.summary       = %q{Ruby helper for Kigo API}
+  spec.description   = %q{Ruby helper for Kigo API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/kigo.rb

@@ -0,0 +1,175 @@
+require "kigo/version"
+require "kigo/configuration"
+require "typhoeus"
+
+module Kigo
+  APIUrl = 'https://app.kigo.net/api/ra/v1'
+
+  def self.wrap_request(end_point, request_method, data={}, headers={})
+    basic_auth = { username: Kigo.configuration.username, password: Kigo.configuration.password }
+    encoded_auth = "Basic #{Base64.strict_encode64("#{basic_auth[:username]}:#{basic_auth[:password]}")}"
+    data = self.filter_params(data)
+    request_options = { method: request_method, headers: headers.merge(
+        { 'Authorization' => encoded_auth,
+          'Content-Type' => 'application/json' }
+      ) }
+    request_options = request_options.merge(request_method == :post ? { body: data.to_json } : { params: data.to_json })
+    Typhoeus::Request.new("#{APIUrl}#{end_point}", request_options)
+  end
+
+  def self.access_multiple(resources=[])
+    hydra = Typhoeus::Hydra.new
+    request_responses = []
+
+    resources.each do |resource|
+      request = self.wrap_request(resource[:end_point], resource[:verb], resource[:params], resource[:headers])
+      request.on_complete do |response|
+        request_responses << self.parse_response(response)
+      end
+      hydra.queue(request)
+    end
+    hydra.run
+    request_responses
+  end
+
+  def self.access(end_point, request_method, data={}, headers={})
+    request = self.wrap_request(end_point, request_method, data, headers)
+    request.on_complete do |response|
+      return self.parse_response(response)
+    end
+    hydra = Typhoeus::Hydra.new
+    hydra.queue(request)
+    hydra.run
+  end
+
+  def self.parse_response(response)
+    if response.success?
+      begin
+        result = JSON.parse(response.body)
+        return result["API_RESULT_CODE"] == "E_OK" ? result["API_REPLY"] : { 'error' => "#{result["API_RESULT_CODE"]} #{result["API_RESULT_TEXT"]}" }
+      rescue
+        return { 'error' => "Error parsing reply" }
+      end
+    else
+      return { 'error' => "Response error. #{response.code} #{response.body}" }
+    end
+  end
+
+  def self.filter_params(hash)
+    filtered_attr = {}
+    hash.each do |param_name, value|
+      if value.is_a? Hash
+        filtered_attr = filtered_attr.merge(param_name => filter_params(value))
+      elsif value.is_a? Array
+        filtered_attr = filtered_attr.merge(param_name => filter_array_params(value))
+      else
+        if value.class == ActionDispatch::Http::UploadedFile
+          filtered_attr = filtered_attr.merge(param_name => value.tempfile)
+        else
+          filtered_attr = filtered_attr.merge(param_name => value)
+        end
+      end
+    end
+    return filtered_attr
+  end
+
+  def self.filter_array_params(array)
+    return array.map { |a| a.is_a?(Hash) ? self.filter_params(a) : a }
+  end
+
+  def self.ping
+    self.access('/ping', :post, {})
+  end
+
+
+  # Reservations
+  def self.diff_property_calendar_reservations(diff_id = nil)
+    self.access('/diffPropertyCalendarReservations', :post, { 'DIFF_ID' => diff_id })
+  end
+
+  def self.createConfirmedReservation(params)
+    # params example:
+    # {
+    #   "PROP_ID" => 1434,
+    #   "RES_CHECK_IN" => "2011-07-21",
+    #   "RES_CHECK_OUT" => "2011-07-26",
+    #   "RES_N_ADULTS" => 2,
+    #   "RES_N_CHILDREN" => 1,
+    #   "RES_N_BABIES" => 0,
+    #   "RES_GUEST" => {
+    #     "RES_GUEST_FIRSTNAME" => "Robert",
+    #     "RES_GUEST_LASTNAME" => "Roquefort",
+    #     "RES_GUEST_EMAIL" => "robert@yahoo.co.uk",
+    #     "RES_GUEST_PHONE" => "",
+    #     "RES_GUEST_COUNTRY" => "GB"
+    #   },
+    #   "RES_COMMENT" => "",
+    #   "RES_COMMENT_GUEST" => "",
+    #   "RES_UDRA" => [
+    #     {
+    #       "UDRA_ID" => 161,
+    #       "UDRA_CHOICE_ID" => 199
+    #     },
+    #     {
+    #       "UDRA_ID" => 162,
+    #       "UDRA_TEXT" => "John Smith told me about you!"
+    #     }
+    #   ]
+    # }
+    self.access('/createConfirmedReservation', :post, params)
+  end
+
+  #Properties
+  def self.list_properties
+    self.access('/listProperties', :post)
+  end
+
+  def self.read_property(property_id)
+    self.access('/readProperty', :post, { 'PROP_ID' => property_id })
+  end
+
+  # Pricing
+  def self.read_property_pricing_setup(property_id)
+    self.access('/readPropertyPricingSetup', :post, { 'PROP_ID' => property_id })
+  end
+
+  def self.diff_property_pricing_setup(diff_id = nil)
+    self.access('/diffPropertyPricingSetup', :post, { 'DIFF_ID' => diff_id })
+  end
+
+#  Example of pricing hash:
+#  { "RENT" => {
+#      "PERGUEST_CHARGE" => nil,
+#      "PERIODS" => [
+#        { "CHECK_IN" => "2014-01-01",
+#          "CHECK_OUT" => "2014-03-01",
+#          "NAME" => "Winter 2014",
+#          "STAY_MIN" => { "UNIT" => "NIGHT", "NUMBER" => 3 },
+#          "WEEKLY" => false,
+#          "NIGHTLY_AMOUNTS" => [
+#            { "GUESTS_FROM" => 1,
+#              "WEEK_NIGHTS" => [ 1, 2, 3, 4, 5, 6, 7 ],
+#              "STAY_FROM" => { "UNIT" => "NIGHT", "NUMBER" => 1 },
+#              "AMOUNT" => "100.00"
+#            }
+#          ]
+#        },
+#        { "CHECK_IN" => "2014-03-01",
+#          "CHECK_OUT" => "2014-05-31",
+#          "NAME" => "",
+#          "STAY_MIN" => { "UNIT" => "NIGHT", "NUMBER" => 7 },
+#          "WEEKLY" => true,
+#          "WEEKLY_AMOUNTS" => [
+#            { "GUESTS_FROM" => 1,
+#              "AMOUNT" => "650.00"
+#            }
+#          ]
+#        }
+#      ]
+#    }
+#  }
+  def self.update_property_pricing_setup(property_id, pricing)
+    self.access('/updatePropertyPricingSetup', :post, { 'PROP_ID' => property_id, 'PRICING' => pricing })
+  end
+
+end

data/lib/kigo/configuration.rb

@@ -0,0 +1,26 @@
+module Kigo
+  class Configuration
+    attr_accessor :username, :password
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Configure Kigo someplace sensible,
+  # like config/initializers/kigo.rb
+  #
+  # @example
+  #   Kigo.configure do |config|
+  #     config.username = 'your username'
+  #     config.password = 'your password'
+  #   end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/kigo/version.rb

@@ -0,0 +1,3 @@
+module Kigo
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: kigo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rijaludin Muhsin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Ruby helper for Kigo API
+email:
+- rijaludinmuhsin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kigo.gemspec
+- lib/kigo.rb
+- lib/kigo/configuration.rb
+- lib/kigo/version.rb
+homepage: ''
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Ruby helper for Kigo API
+test_files: []