g5_updatable 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,116 @@
+# G5 Updatable
+
+[![Build Status](https://travis-ci.org/G5/g5_updatable.png?branch=master)](https://travis-ci.org/G5/g5_updatable)
+
+G5 Updatable provides a solution for automatic updates of client and location
+data when modified or created in the G5 Hub.
+
+## Current Version
+
+NOT RELEASED
+
+## Installation
+
+1. Add this line to your application's Gemfile:
+
+   ```ruby
+   gem 'g5_updatable'
+   ```
+
+2. And then execute:
+
+   ```console
+   bundle
+   ```
+
+3. Run the generator.
+
+   ```ruby
+   rails g g5_updatable:install
+   ```
+
+   This creates an initilizer at config/initializers/g5_updatable.rb,
+   and mounts the engine at `/g5_updatable`.
+
+## Configuration
+
+You can cofigure options within the generated initializer.
+
+```ruby
+# config/initilizers/g5_updatable.rb
+G5Updatable.setup do |config|
+  # base path to the G5 Hub
+  config.feed_endpoint = #string
+
+  # identifier of the client (urn)
+  config.client_identifier = #string
+
+  # default is true. When set to true, existing locations in your app will be
+  # updated with any changes made to the hub. If set to false, existing locations
+  # will be skipped and only newly added locations will be created.
+  config.update_locations = #boolean
+
+  # default is false. When set to true, client data will update.
+  config.update_client = #boolean
+
+  # default is [:name]. A whitlist of parameters to create/update on the model
+  config.location_parameters = #array of symbols
+
+  # default is [:name]. A whitlist of parameters to update on the model
+  config.client_parameters = #array of symbols
+end
+```
+
+## Usage
+
+G5 Updatable exposes a POST route at `/g5_updatable/update` that accepts a urn
+parameter (client identifier within the hub). When the route is
+hit, it will update/create Location and Client data based on the configuration.
+See the [G5-Hub](https://github.com/G5/g5_hub) webhook logic for further info.
+
+## Authors
+
+* Brian Bauer / [@bbauer](https://github.com/bbauer)
+
+## Contributing
+
+1. [Fork it](https://github.com/G5/g5_updatable/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write your code and **specs**
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+If you find bugs, have feature requests or questions, please
+[file an issue](https://github.com/G5/g5_updatable/issues).
+
+## Specs
+
+```bash
+$ rspec spec
+```
+
+## License
+
+Copyright (c) 2014 G5
+
+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/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'G5Updatable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+task :default => :spec

data/app/assets/javascripts/g5_updatable/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/g5_updatable/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/g5_updatable/application_controller.rb

@@ -0,0 +1,4 @@
+module G5Updatable
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/g5_updatable/feed_controller.rb

@@ -0,0 +1,9 @@
+class G5Updatable::FeedController < ApplicationController
+  skip_before_filter :authenticate_user!
+  skip_before_filter :verify_authenticity_token
+
+  def update
+    G5Updatable::ClientFeedProcessor.new(params[:urn]).work
+    render json: {}, status: :ok
+  end
+end

data/app/helpers/g5_updatable/application_helper.rb

@@ -0,0 +1,4 @@
+module G5Updatable
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/g5_updatable/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>G5Updatable</title>
+  <%= stylesheet_link_tag    "g5_updatable/application", media: "all" %>
+  <%= javascript_include_tag "g5_updatable/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+G5Updatable::Engine.routes.draw do
+  post "/update" => "feed#update"
+end

data/lib/g5_updatable.rb

@@ -0,0 +1,5 @@
+require "g5_updatable/engine"
+require "g5_updatable/client_feed_processor"
+
+module G5Updatable
+end

data/lib/g5_updatable/client_feed_processor.rb

@@ -0,0 +1,22 @@
+require "g5_updatable/feed_mapper"
+require "g5_updatable/client_updater"
+require "g5_updatable/locations_updater"
+
+class G5Updatable::ClientFeedProcessor
+  def initialize(urn=nil)
+    @urn = urn || G5Updatable.client_identifier
+  end
+
+  def work
+    if @urn
+      G5Updatable::ClientUpdater.new(feed_mapper.client).update
+      G5Updatable::LocationsUpdater.new(feed_mapper.locations).update
+    end
+  end
+
+private
+
+  def feed_mapper
+    @feed_mapper ||= G5Updatable::FeedMapper.new(@urn)
+  end
+end

data/lib/g5_updatable/client_updater.rb

@@ -0,0 +1,25 @@
+class G5Updatable::ClientUpdater
+  def initialize(g5_client)
+    @g5_client = g5_client
+  end
+
+  def update
+    return unless G5Updatable.update_client && client
+
+    G5Updatable.client_parameters.each do |parameter|
+      client.send("#{parameter}=", @g5_client.send(parameter))
+    end
+
+    client.save
+  end
+
+private
+
+  def client
+    @client ||= Client.find_by(uid: client_uid) if client_uid
+  end
+
+  def client_uid
+    "#{G5Updatable.feed_endpoint}#{G5Updatable.client_identifier}"
+  end
+end

data/lib/g5_updatable/engine.rb

@@ -0,0 +1,28 @@
+module G5Updatable
+  class Engine < ::Rails::Engine
+    isolate_namespace G5Updatable
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :fabrication, dir: 'spec/fabricators'
+      g.assets false
+      g.helper false
+    end
+  end
+
+  class << self
+    mattr_accessor :client_identifier, :feed_endpoint, :location_parameters,
+                   :client_parameters, :update_client, :update_locations
+
+    self.client_identifier   = nil
+    self.feed_endpoint       = "http://g5-hub.herokuapp.com/clients/"
+    self.location_parameters = [:name]
+    self.client_parameters   = [:name]
+    self.update_client       = false
+    self.update_locations    = true
+  end
+
+  def self.setup(&block)
+    yield self
+  end
+end

data/lib/g5_updatable/feed_mapper.rb

@@ -0,0 +1,57 @@
+require "g5_updatable/g5_client"
+require "g5_updatable/g5_location"
+require "microformats2"
+
+class G5Updatable::FeedMapper
+  def initialize(urn)
+    @urn  = urn
+    @feed = Microformats2.parse(client_uid).first if @urn
+  end
+
+  def client
+    G5Updatable::G5Client.new(client_parameters) if @feed
+  end
+
+  def locations
+    return [] if @feed.blank?
+
+    @feed.orgs.map do |location|
+      G5Updatable::G5Location.new(location_parameters(location.format))
+    end
+  end
+
+private
+
+  def client_uid
+    "#{G5Updatable.feed_endpoint}#{@urn}" if @urn.present?
+  end
+
+  def client_parameters
+    {
+      name:  @feed.name.to_s,
+      vertical:  @feed.g5_vertical.to_s,
+      domain:  @feed.g5_domain.to_s,
+      type:  @feed.g5_domain_type.to_s
+    }
+  end
+
+  def location_parameters(location)
+    {
+      uid: location.uid.to_s,
+      urn: location.uid.to_s.split("/").last,
+      name: location.name.to_s,
+      domain: location.g5_domain.to_s,
+      street_address: location.adr.try(:format).try(:street_address).to_s,
+      state: location.adr.try(:format).try(:region).to_s,
+      city: location.adr.try(:format).try(:locality).to_s,
+      neighborhood: location.adr.try(:format).try(:g5_neighborhood).to_s,
+      postal_code: location.adr.try(:format).try(:postal_code).to_s,
+      phone_number: location.adr.try(:format).try(:tel).to_s,
+      corporate: location.g5_corporate.to_s,
+      floor_plans: location.g5_floorplan.to_s,
+      primary_amenity: location.g5_aparment_amenity_1.to_s,
+      qualifier: location.g5_aparment_feature_1.to_s,
+      primary_landmark: location.g5_landmark_1.to_s
+    }
+  end
+end

data/lib/g5_updatable/g5_client.rb

@@ -0,0 +1,10 @@
+require "virtus"
+
+class G5Updatable::G5Client
+  include Virtus
+
+  attribute :name, String
+  attribute :vertical, String
+  attribute :domain, String
+  attribute :type, String
+end

data/lib/g5_updatable/g5_location.rb

@@ -0,0 +1,21 @@
+require "virtus"
+
+class G5Updatable::G5Location
+  include Virtus
+
+  attribute :uid, String
+  attribute :urn, String
+  attribute :name, String
+  attribute :domain, String
+  attribute :street_address, String
+  attribute :state, String
+  attribute :city, String
+  attribute :neighborhood, String
+  attribute :postal_code, String
+  attribute :phone_number, String
+  attribute :corporate, String
+  attribute :floor_plans, String
+  attribute :primary_amenity, String
+  attribute :qualifier, String
+  attribute :primary_landmark, String
+end

data/lib/g5_updatable/locations_updater.rb

@@ -0,0 +1,29 @@
+class G5Updatable::LocationsUpdater
+  def initialize(locations)
+    @locations = locations
+  end
+
+  def update
+    @locations.each { |location| process(location) unless skip?(location) }
+  end
+
+private
+
+  def process(g5_location)
+    location = Location.find_or_initialize_by(urn: urn_for(g5_location))
+
+    G5Updatable.location_parameters.each do |parameter|
+      location.send("#{parameter}=", g5_location.send(parameter))
+    end
+
+    location.save
+  end
+
+  def skip?(location)
+    Location.exists?(urn: urn_for(location)) && !G5Updatable.update_locations
+  end
+
+  def urn_for(location)
+    location.uid.to_s.split("/").last
+  end
+end