bookingsync_portal 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a480ce2459ec1089601197319ee60201436263d
-  data.tar.gz: e282f8169d93c61ae942716c5fb2bb31a9790bc7
+  metadata.gz: 7bce44a09e365af14bee6025bdbaf505b5cbaa3e
+  data.tar.gz: 672dc73f92f93d0d3e0d9aa18199b73b201d7ded
 SHA512:
-  metadata.gz: 695f61dd565e424616ba9f16792146fea0212de4185b512f9916a52a6c0bc7afd8b3bb16834b2d2efcfd0de81d19d0ab5e8fefe09beb367b63d3953be5dfe1a9
-  data.tar.gz: 529f1ee3232b275d0585bab5ed511a1d26093d358f43fa22ef7bcd4e7e6fe785c5946cb0fbea2435b266ddeb7e32f1b4361e38390f12b990415d4acc63610f04
+  metadata.gz: cb08b602aef04800fd3608c2db757bb2b8d5b8aa0ae62611d4bfe66c4926638511476a4401ebe22684ed15b5c0b434ccab5d8f45f94990038b4d0acfbf44b749
+  data.tar.gz: d0026be5f43c6fe11bd6b240f36f719ef0eecc243468a116433e3b23e179dbe16401dc70cb33d61edb3678913b3bb957be8b1c0049f3b73767d847fccb8d54b9

data/README.md

@@ -1,8 +1,85 @@
+[![Code Climate](https://codeclimate.com/github/BookingSync/bookingsync_portal/badges/gpa.svg)](https://codeclimate.com/github/BookingSync/bookingsync_portal)
+[![Build Status](https://travis-ci.org/BookingSync/bookingsync_portal.svg?branch=master)](https://travis-ci.org/BookingSync/bookingsync_portal)
+
 # BookingsyncPortal
 
-* A common base for creating BookingSync portal applications.
+A Rails engine to simplify building BookingSync Portal Applications.
+
+## Requirements
+
+This engine requires Rails `>= 4.0.0` and Ruby `>= 2.0.0`.
+
+## Documentation
+
+[API documentation is available at rdoc.info](http://rdoc.info/github/BookingSync/bookingsync_portal/master/frames).
+
+## Installation
+
+BookingSync Portal works with Rails 4.0 onwards and Ruby 2.0 onwards. To get started, add it to your Gemfile with:
+
+```ruby
+gem 'bookingsync_portal'
+```
+
+Then bundle install:
+
+```ruby
+bundle install
+```
+
+### Add routes
+
+BookingSync Authorization routes need to be mounted inside you apps `routes.rb`:
+
+```ruby
+mount BookingSync::Engine => '/'
+```
+
+This will add the following routes:
+
+* `/auth/bookingsync/callback`
+* `/auth/failure`
+* `/signout`
+
+as well as BookingSync Portal controllers routes:
+
+```ruby
+mount BookingsyncPortal::Engine => '/'
+```
+
+### Migrations
+
+BookingSync Portal provide migrations for the most common models:
+* `Account`: BookingSync accounts,
+* `Connection`: connection between `rentals` and `remote_rentals`,
+* `Photo`: BookingSync rentals' photos,
+* `Rate`: BookingSync rentals' rates,
+* `RemoteAccount`: Portal accounts,
+* `RemoteRental`: Portal rentals,
+* `Rental`: BookingSync rentals,
+
+You can copy the migrations file to your application by running:
+
+```console
+rake bookingsync_portal:install:migrations
+```
+
+then run the migration:
+
+```console
+rake db:migrate
+```
 
-# Setup
+### Add initializer and default models
+
+This will install a configuration file in `config/initializers/bookingsync_portal.rb` as well as creating default models:
+
+```console
+rails g bookingsync_portal:install
+```
+
+
+### Assets
 
 You will need to install the assets for each namespace:
 
@@ -45,3 +122,47 @@ in `/app/assets/javascripts/admin/application.css.scss`:
  */
 
 ```
+
+
+_Note: When saving new token, this gem uses a separate thread with new db connection to ensure token save (in case of a rollback in the main transaction). To make room for the new connections, it is recommended to increase db `pool` size by 2-3._
+
+## Configuration
+
+The engine is configured by the following ENV variables:
+
+* `BOOKINGSYNC_URL` - the url of the website, should be `https://www.bookingsync.com`
+* `BOOKINGSYNC_APP_ID` - BookingSync Application's Client ID
+* `BOOKINGSYNC_APP_SECRET` - BookingSync Application's Client Secret
+* `BOOKINGSYNC_VERIFY_SSL` - Verify SSL (available only in development or test). Default to false
+* `BOOKINGSYNC_SCOPE` - Space separated list of required scopes. Defaults to nil, which means the public scope.
+
+You might want to use [dotenv-rails](https://github.com/bkeepers/dotenv)
+to make ENV variables management easy.
+
+## Testing
+
+### RSpec
+
+We do provide some helper for RSpec users, you can include them in your `spec/rails_helper.rb` (before `spec/support` inclusion):
+```
+require 'bookingsync_application/spec_helper'
+```
+
+### VCR
+
+We recommend a VCR setup inspired from the following configuration. It will mask authorization tokens from your fixtures:
+
+```ruby
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/cassettes'
+  config.hook_into :webmock
+  config.configure_rspec_metadata!
+  config.filter_sensitive_data('BOOKINGSYNC_OAUTH_ACCESS_TOKEN') do
+    ENV['BOOKINGSYNC_OAUTH_ACCESS_TOKEN']
+  end
+  # Uncomment if using codeclimate
+  # config.ignore_hosts 'codeclimate.com'
+end
+```

data/app/assets/javascripts/bookingsync_portal/admin/handle_remote_errors.js.coffee

@@ -1,3 +1,3 @@
 $ ->
-  $(document).on "ajax:error", "[data-remote]", (e, xhr) ->
+  $(document).ajaxError (e, xhr) ->
     location.reload() if xhr.status == 401

data/app/models/bookingsync_portal/account.rb

@@ -7,4 +7,9 @@ class BookingsyncPortal::Account < ActiveRecord::Base
   has_many :remote_rentals, class_name: BookingsyncPortal.remote_rental_model, through: :remote_accounts
   has_many :rentals, class_name: BookingsyncPortal.rental_model, dependent: :destroy
   has_many :connections, class_name: BookingsyncPortal.connection_model, through: :rentals
+
+  # Used to synchronize accounts using `Account.synchronize(remove: true)`
+  def self.api
+    BookingSync::API::Client.new(BookingSync::Engine.application_token.token)
+  end
 end

data/app/models/bookingsync_portal/photo.rb

@@ -0,0 +1,8 @@
+class BookingsyncPortal::Photo < ActiveRecord::Base
+  self.table_name = 'photos'
+
+  belongs_to :rental
+  has_one    :account, through: :rental
+
+  scope :ordered, -> { order position: :asc }
+end

data/app/models/bookingsync_portal/rate.rb

@@ -0,0 +1,6 @@
+class BookingsyncPortal::Rate < ActiveRecord::Base
+  self.table_name = 'rates'
+
+  belongs_to :rental
+  has_one    :account, through: :rental
+end

data/app/models/bookingsync_portal/rental.rb

@@ -2,8 +2,10 @@ class BookingsyncPortal::Rental < ActiveRecord::Base
   self.table_name = 'rentals'
 
   belongs_to :account, class_name: BookingsyncPortal.account_model
-  has_one :connection, class_name: BookingsyncPortal.connection_model, dependent: :destroy
-  has_one :remote_rental, class_name: BookingsyncPortal.remote_rental_model, through: :connection
+  has_one    :connection, class_name: BookingsyncPortal.connection_model, dependent: :destroy
+  has_one    :remote_rental, class_name: BookingsyncPortal.remote_rental_model, through: :connection
+  has_many   :photos, class_name: BookingsyncPortal.photo_model, dependent: :destroy
+  has_many   :rates, class_name: BookingsyncPortal.rate_model, dependent: :destroy
 
   validates :synced_id, uniqueness: true, presence: true
 
@@ -15,4 +17,8 @@ class BookingsyncPortal::Rental < ActiveRecord::Base
   def connected?
     remote_rental.present?
   end
+
+  def ordered_photos
+    photos.ordered
+  end
 end

data/app/resources/bookingsync_portal/admin_api/connection_resource.rb

@@ -3,7 +3,7 @@ module BookingsyncPortal
     class ConnectionResource < JSONAPI::Resource
       model_name BookingsyncPortal.connection_model
 
-      attributes :id, :rental_id, :remote_rental_id
+      attributes :rental_id, :remote_rental_id
 
       def self.records(options = {})
         context = options[:context]

data/app/resources/bookingsync_portal/admin_api/remote_account_resource.rb

@@ -3,7 +3,7 @@ module BookingsyncPortal
     class RemoteAccountResource < JSONAPI::Resource
       model_name BookingsyncPortal.remote_account_model
 
-      attributes :id, :uid
+      attributes :uid
 
       def self.records(options = {})
         context = options[:context]

data/app/resources/bookingsync_portal/admin_api/remote_rental_resource.rb

@@ -3,8 +3,6 @@ module BookingsyncPortal
     class RemoteRentalResource < JSONAPI::Resource
       model_name BookingsyncPortal.remote_rental_model
 
-      attributes :id
-
       def self.records(options = {})
         context = options[:context]
         context[:current_account].remote_rentals

data/app/resources/bookingsync_portal/admin_api/rental_resource.rb

@@ -3,8 +3,6 @@ module BookingsyncPortal
     class RentalResource < JSONAPI::Resource
       model_name BookingsyncPortal.rental_model
 
-      attributes :id
-
       def self.records(options = {})
         context = options[:context]
         context[:current_account].rentals

data/app/views/bookingsync_portal/admin/rentals/_remote_rental.html.erb

@@ -2,7 +2,7 @@
   data-uid="<%= remote_rental.uid %>">
   <div class="panel-heading" title="<%= RemoteRental.human_attribute_name(:uid) %>
     <%= remote_rental.uid %>">
-    <%= remote_rental.remote_account.uid%>:
+    <%= remote_rental.remote_account.uid %>:
     <%= remote_rental.name %>
   </div>
   <div class="panel-body">

data/app/views/bookingsync_portal/admin/rentals/index.html.erb

@@ -6,7 +6,7 @@
     <div class="rentals-list-scroll">
       <%- if @visible_rentals_count == 0 -%>
         <div class="lead text-center well">
-          <p><%= t('.no_published_rentals_html', id: current_account.uid) %></p>
+          <p><%= t('.no_published_rentals_html', id: current_account.synced_id) %></p>
         </div>
       <%- elsif @not_connected_rentals.count > 0 -%>
         <% @not_connected_rentals.each do |rental| %>

data/config/locales/en.yml

@@ -42,6 +42,7 @@ en:
             other: '<strong>%{count}</strong> People'
           surface_html:
             zero: ''
+            one: '<span>Surface</span> <strong>%{count}m²</strong>'
             other: '<span>Surface</span> <strong>%{count}m²</strong>'
           no_name: Unnamed rental
         remote_rental:

data/db/migrate/20150222172825_create_accounts.rb

@@ -2,12 +2,16 @@ class CreateAccounts < ActiveRecord::Migration
   def change
     create_table :accounts do |t|
       t.string :provider
-      t.integer :uid, index: true
+      t.integer :synced_id, index: true
       t.string :name
       t.string :oauth_access_token
       t.string :oauth_refresh_token
       t.datetime :oauth_expires_at
-      t.timestamps
+      t.text :synced_data
+      t.datetime :synced_all_at
+      t.string :email
+
+      t.timestamps null: false
     end
   end
 end

data/db/migrate/20150222173413_create_rentals.rb

@@ -8,7 +8,7 @@ class CreateRentals < ActiveRecord::Migration
       t.integer :position
       t.datetime :published_at
 
-      t.timestamps
+      t.timestamps null: false
     end
   end
 end

data/db/migrate/20150222173711_create_remote_accounts.rb

@@ -4,7 +4,7 @@ class CreateRemoteAccounts < ActiveRecord::Migration
       t.belongs_to :account, index: true
       t.integer :uid
 
-      t.timestamps
+      t.timestamps null: false
     end
   end
 end

data/db/migrate/20150222174023_create_remote_rentals.rb

@@ -6,7 +6,7 @@ class CreateRemoteRentals < ActiveRecord::Migration
       t.text :remote_data
       t.datetime :synchronized_at
 
-      t.timestamps
+      t.timestamps null: false
     end
   end
 end

data/db/migrate/20150222174234_create_connections.rb

@@ -3,7 +3,8 @@ class CreateConnections < ActiveRecord::Migration
     create_table :connections do |t|
       t.belongs_to :remote_rental, index: true
       t.belongs_to :rental, index: true
-      t.timestamps
+
+      t.timestamps null: false
     end
   end
 end

data/db/migrate/20150520134912_create_photos.rb

@@ -0,0 +1,13 @@
+class CreatePhotos < ActiveRecord::Migration
+  def change
+    create_table :photos do |t|
+      t.belongs_to :rental, index: true
+      t.integer :synced_id, index: true
+      t.text :synced_data
+      t.datetime :synced_all_at
+      t.integer :position
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20150521091056_create_rates.rb

@@ -0,0 +1,12 @@
+class CreateRates < ActiveRecord::Migration
+  def change
+    create_table :rates do |t|
+      t.belongs_to :rental, index: true
+      t.integer :synced_id, index: true
+      t.text :synced_data
+      t.datetime :synced_all_at
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/bookingsync_portal.rb

@@ -34,10 +34,18 @@ module BookingsyncPortal
   mattr_accessor :remote_rental_model
   @@remote_rental_model = 'BookingsyncPortal::RemoteRental'
 
-  # remote rental model class
+  # connection model class
   mattr_accessor :connection_model
   @@connection_model = 'BookingsyncPortal::Connection'
 
+  # photo model class
+  mattr_accessor :photo_model
+  @@photo_model = 'BookingsyncPortal::Photo'
+
+  # rate model class
+  mattr_accessor :rate_model
+  @@rate_model = 'BookingsyncPortal::Rate'
+
   # account resource class
   mattr_accessor :account_resource
   @@account_resource = 'BookingsyncPortal::AdminApi::AccountResource'

data/lib/bookingsync_portal/version.rb

@@ -1,3 +1,3 @@
 module BookingsyncPortal
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/generators/bookingsync_portal/install_generator.rb

@@ -5,11 +5,18 @@ module BookingsyncPortal
     class InstallGenerator < ::Rails::Generators::Base
       source_root File.expand_path("../../templates", __FILE__)
 
-      desc "Creates a BookingsyncPortal initializer."
+      desc "Creates a BookingsyncPortal initializer and default models."
 
       def copy_initializer
-        template "bookingsync_portal.rb", "config/initializers/bookingsync_portal.rb"
+        template "initializers/bookingsync_portal.rb", "config/initializers/bookingsync_portal.rb"
+        template "models/account.rb", "app/models/account.rb"
+        template "models/connection.rb", "app/models/connection.rb"
+        template "models/photo.rb", "app/models/photo.rb"
+        template "models/rate.rb", "app/models/rate.rb"
+        template "models/remote_account.rb", "app/models/remote_account.rb"
+        template "models/remote_rental.rb", "app/models/remote_rental.rb"
+        template "models/rental.rb", "app/models/rental.rb"
       end
     end
   end
-end
+end

data/lib/generators/templates/{bookingsync_portal.rb → initializers/bookingsync_portal.rb}

@@ -1,19 +1,25 @@
 # Use this to customize the behaviour of BookingsyncPortal engine and hook up custom synchronization
 BookingsyncPortal.setup do |config|
   # customize account model class, can extend BookingsyncPortal::Account
-  # config.account_model = '::Account'
+  config.account_model = '::Account'
 
   # customize remote account model class, can extend BookingsyncPortal::RemoteAccount
-  # config.remote_account_model = '::RemoteAccount'
+  config.remote_account_model = '::RemoteAccount'
 
   # customize rental model class, can extend BookingsyncPortal::Rental
-  # config.rental_model = '::Rental'
+  config.rental_model = '::Rental'
 
   # customize remote_rental model class, can extend BookingsyncPortal::RemoteRental
-  # config.remote_rental_model = '::RemoteRental'
+  config.remote_rental_model = '::RemoteRental'
 
   # customize connection model class, can extend BookingsyncPortal::Connection
-  # config.connection_model = '::Connection'
+  config.connection_model = '::Connection'
+
+  # customize photo model class, can extend BookingsyncPortal::Photo
+  config.photo_model = '::Photo'
+
+  # customize rate model class, can extend BookingsyncPortal::Rate
+  config.rate_model = '::Rate'
 
   # customize account resource class, can extend BookingsyncPortal::AdminApi::AccountResource
   # config.account_resource = '::AdminApi::AccountResource'
@@ -43,4 +49,3 @@ BookingsyncPortal.setup do |config|
     # return false if remote account is not present or not valid
   end
 end
-

data/lib/generators/templates/models/account.rb

@@ -0,0 +1,14 @@
+class Account < BookingsyncPortal::Account
+  synced local_attributes: [:email]
+
+  # Uncomment to add Rails logger
+  # def api
+  #   @api ||= BookingSync::Engine::APIClient.new(token.token, logger: Rails.logger, account: self)
+  # end
+
+  # Uncomment to add Rails logger
+  # # Used to synchronize accounts using `Account.synchronize(remove: true)`
+  # def self.api
+  #   BookingSync::API::Client.new(BookingSync::Engine.application_token.token, logger: Rails.logger)
+  # end
+end

data/lib/generators/templates/models/connection.rb

@@ -0,0 +1,2 @@
+class Connection < BookingsyncPortal::Connection
+end

data/lib/generators/templates/models/photo.rb

@@ -0,0 +1,4 @@
+class Photo < BookingsyncPortal::Photo
+  synced local_attributes: [:position], delegate_attributes: [:large_url, :thumb_url],
+    remove: true
+end

data/lib/generators/templates/models/rate.rb

@@ -0,0 +1,3 @@
+class Rate < BookingsyncPortal::Rate
+  synced remove: true
+end

data/lib/generators/templates/models/remote_account.rb

@@ -0,0 +1,6 @@
+class RemoteAccount < BookingsyncPortal::RemoteAccount
+  # Returns the name of this portal account. Should be easy to identify.
+  def name
+    uid
+  end
+end

data/lib/generators/templates/models/remote_rental.rb

@@ -0,0 +1,6 @@
+class RemoteRental < BookingsyncPortal::RemoteRental
+  # Returns the name of this portal rental. Should be easy to identify.
+  def name
+    uid
+  end
+end

data/lib/generators/templates/models/rental.rb

@@ -0,0 +1,6 @@
+class Rental < BookingsyncPortal::Rental
+  synced associations: [:photos, :rates],
+    local_attributes: [:position, :published_at],
+    include: [:availability],
+    delegate_attributes: [:name, :sleeps, :sleeps_max, :bedrooms_count, :bathrooms_count, :surface]
+end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: bookingsync_portal
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Marciniak
+- Sebastien Grosjean
+- Artur Krzeminski Freda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,14 +46,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -304,9 +306,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
+description: A common base for creating BookingSync portal applications.
 email:
 - mandaryyyn@gmail.com
+- dev@bookingsync.com
+- artur@bookingsync.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -333,6 +337,8 @@ files:
 - app/helpers/bookingsync_portal/admin/rentals_helper.rb
 - app/models/bookingsync_portal/account.rb
 - app/models/bookingsync_portal/connection.rb
+- app/models/bookingsync_portal/photo.rb
+- app/models/bookingsync_portal/rate.rb
 - app/models/bookingsync_portal/remote_account.rb
 - app/models/bookingsync_portal/remote_rental.rb
 - app/models/bookingsync_portal/rental.rb
@@ -358,12 +364,21 @@ files:
 - db/migrate/20150222173711_create_remote_accounts.rb
 - db/migrate/20150222174023_create_remote_rentals.rb
 - db/migrate/20150222174234_create_connections.rb
+- db/migrate/20150520134912_create_photos.rb
+- db/migrate/20150521091056_create_rates.rb
 - lib/bookingsync_portal.rb
 - lib/bookingsync_portal/engine.rb
 - lib/bookingsync_portal/mash_serializer.rb
 - lib/bookingsync_portal/version.rb
 - lib/generators/bookingsync_portal/install_generator.rb
-- lib/generators/templates/bookingsync_portal.rb
+- lib/generators/templates/initializers/bookingsync_portal.rb
+- lib/generators/templates/models/account.rb
+- lib/generators/templates/models/connection.rb
+- lib/generators/templates/models/photo.rb
+- lib/generators/templates/models/rate.rb
+- lib/generators/templates/models/remote_account.rb
+- lib/generators/templates/models/remote_rental.rb
+- lib/generators/templates/models/rental.rb
 - lib/tasks/bookingsync_portal_tasks.rake
 homepage: https://github.com/BookingSync/bookingsync_portal
 licenses:
@@ -385,8 +400,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A common base for creating BookingSync portal applications.
 test_files: []
+has_rdoc: