pliable 0.1.0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+addons:
+  postgresql: 9.2
+
+before_script:
+  - psql -c 'create database dummy_test;' -U postgres
+
+script:
+  - cd spec/dummy/
+  - bundle exec rake db:test:prepare
+  - cd ../..
+  - bundle exec rspec

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "pliable Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1 / 2014-01-17
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gemspec
+
+group :development do
+  gem 'kramdown'
+end

data/Gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: .
+  specs:
+    pliable (0.1)
+      pg
+      rails (>= 4.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.0.2)
+      actionpack (= 4.0.2)
+      mail (~> 2.5.4)
+    actionpack (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activerecord (4.0.2)
+      activemodel (= 4.0.2)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.2)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.1)
+    atomic (1.1.14)
+    builder (3.1.4)
+    coderay (1.1.0)
+    columnize (0.3.6)
+    database_cleaner (1.0.1)
+    debugger (1.6.5)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.1)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.1)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    kramdown (1.3.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.2)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    mocha (1.0.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.4)
+    pg (0.17.1)
+    polyglot (0.3.3)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-debugger (0.2.2)
+      debugger (~> 1.3)
+      pry (~> 0.9.10)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.2)
+      actionmailer (= 4.0.2)
+      actionpack (= 4.0.2)
+      activerecord (= 4.0.2)
+      activesupport (= 4.0.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.2)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.2)
+      actionpack (= 4.0.2)
+      activesupport (= 4.0.2)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (0.9.6)
+    rspec (2.14.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rubygems-tasks (0.2.4)
+    slop (3.4.7)
+    sprockets (2.10.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  database_cleaner (~> 1.0)
+  kramdown
+  minitest (>= 4.7.5)
+  mocha (~> 1.0.0)
+  pg (~> 0.17.1)
+  pliable!
+  pry (~> 0.9.12)
+  pry-debugger (~> 0.2)
+  rails (>= 4.0)
+  rake (~> 0.8)
+  rspec (~> 2.14)
+  rubygems-tasks (~> 0.2)
+  yard (~> 0.8)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Mike Piccolo
+
+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,287 @@
+pliable
+============
+| Project                 |  Gem Release      |
+|------------------------ | ----------------- |
+| Gem name                |  pliable      |
+| License                 |  [MIT](LICENSE.txt)   |
+| Version                 |  [![Gem Version](https://badge.fury.io/rb/pliable.png)](http://badge.fury.io/rb/pliable) |
+| Continuous Integration  |  [![Build Status](https://travis-ci.org/mfpiccolo/pliable.png?branch=master)](https://travis-ci.org/mfpiccolo/pliable)
+Z| Grade                   |  [![Code Climate](https://codeclimate.com/github/mfpiccolo/pliable.png)](https://codeclimate.com/github/mfpiccolo/pliable)
+| Homepage                |  [http://mfpiccolo.github.io/pliable][homepage] |
+| Documentation           |  [http://rdoc.info/github/mfpiccolo/pliable/frames][documentation] |
+| Issues                  |  [https://github.com/mfpiccolo/pliable/issues][issues] |
+
+## Description
+
+Pliable makes integrating a Rails project with Schemaless data not so painful.
+
+Rolling your own integration with an external service where the schema can change from moment to moment can be tough.  Pliable makes it a bit easier by giving you a familiar place to store this data (models backed by postgres) and familiar ways of interacting with it (Active Record objects, complete with associations).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "pliable"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pliable
+
+## Features
+
+Pliable allows you to save individual records from external schemaless databases into your postgres
+backed rails apps.  We store all of the data in a plies table.  The Ply model contains logic that allows
+you to inherit from Ply and then act as if these iherited models are normal Active Record models.
+
+Here is the Ply model your generator created:
+
+```ruby
+class Ply < Pliable::Ply
+  # Define methods here that you want all you Ply backed models to have.
+end
+```
+
+Now you can create a model that is backed by Ply.
+
+```ruby
+class Foo < Ply
+  # This is redundant if it is the same name ass the class but required for now.
+  ply_name "Foo"
+  # Define methods that you only want Foo to have.
+end
+```
+
+Now lets make another Ply Backed Model.
+
+```ruby
+class Bar < Ply
+  ply_name "Bar"
+end
+```
+
+Now you should be able to treat these like any other Active Record object with the added bonus of a
+few features.  You can assign any json data to the data attribute.
+
+```ruby
+foo = Foo.create(data: {"some" => "json", "other" => "data"})
+```
+The nice part is now these json keys are methods.
+```ruby
+foo.some => "json"
+```
+
+Another nicety is associations.  You can associate a Ply inhereted class to another using parent
+and child relationships and the PlyRelations model
+```ruby
+foo = Foo.create
+bar = Bar.create
+PlyRealation.create(parent_id: foo.id, parent_type: foo.class.name, child_id: bar, child_type: bar.class.name)
+
+foo.bars => <#<ActiveRecord::AssociationRelation [#<Pliable::Ply id: 2 otype: "Bar" ...>
+```
+
+## Configuration
+
+To use the generator run:
+
+    $ rails g pliable:model
+
+This will set up pliable.rb initializer, create the migration and run it and add a Ply model and specs.
+
+In the initializer, specify any aditional logic you need to prepare the ply_name for pluralization.
+
+```ruby
+Pliable.configure do |config|
+  # Add logic to this bloc to change the names given by external services so we can pluralize.
+  # For instance if you ply names need to gsub __c of the end do:
+  config.added_scrubber {|name| name.gsub('__c', '') }
+end
+```
+
+## Examples
+
+An example of a salesforce integration:
+
+Here is your Ply model:
+
+```ruby
+# Notice it inherits from Pliable::Ply
+class Ply < Pliable::Ply
+
+  # Define methods here that you want all of your models to have
+  def anything_you_like
+    puts "I can play disco all night"
+  end
+
+end
+```
+
+This is an example salesforce Invoice model:
+
+```ruby
+# Notice it inherits from your apps Ply
+class Invoice < Ply
+
+  # If you dont put this you will get all Ply records.
+  # This is the name that you have put into the otype attribute.
+  # In this example I just used the exact salesforce api name
+  ply_name "Invoice__c"
+
+  # Add Invoice specific methods here
+  def what_dosnt_gather_moss?
+    "A rolling stone!"
+  end
+
+end
+```
+
+Here is an example associated salesforce model:
+
+```ruby
+class LineItem < Ply
+
+  ply_name "Line_Item__c"
+
+  # You guessed it.  LineItem specific methods here.
+  def best_pliable_quote
+    "Facts are stubborn, but statistics are more pliable. - Mark Twain"
+  end
+
+end
+```
+
+Here is your PlyRelation model:
+
+```ruby
+# This will probably not be needed in the future and will live in the gem
+class PlyRelation < ActiveRecord::Base
+  belongs_to :parent, class_name: 'Ply'
+  belongs_to :child, class_name: 'Ply'
+end
+```
+
+A service object for pulling salesforce data into your app:
+
+```ruby
+class SalesforceSynch
+
+  attr_reader :user, :client
+
+  def initialize(user)
+    @user = user
+  end
+
+  def call
+    set_clients  # Connect to your Salesforce data (i.e. databsedotcom or restforce)
+    create_plys_from_salesforce_records # Create records in your PG database using Ply model
+    create_ply_relations # Dynamically create associations based on the data recieved
+  end
+
+  def self.call
+    new.call
+  end
+
+  def set_clients
+    #Fake service object that sets up a client to connect to databasedotcom
+    @client = ConnectToDatabasedotcom.call(user.salesforce_credentials)
+  end
+
+  def create_plys_from_salesforce_records
+    data = []
+
+    # sf_api model names as strings in array
+    records = []
+
+    # User has_many :plies in this example (i.e. user.plies)
+    client.get_the_records_you_want.each do |record|
+      object = user.plies.find_or_create_by(oid: record.Id)
+      object.update_attributes(
+        # The data attribute is a json column.  This is where you store all shcemaless data.
+        data: record.attributes,
+        # Whatever the service calls the object (i.e. Invoice__c for salesforce)
+        otype: record.salesforce_api_name,
+        # Use last_checked and last_modified to know when you need to update a record
+        last_checked: Time.zone.now
+      )
+    end
+  end
+
+  # Dynamically deduce if there is a relationship with any of the plys that have been imported.
+  # In the case of saleforce the id of related object is stored by using the name of that
+  # object as a key. (ie "Invoice__c" => "long_uiniq_id").  In this app users choose a few models
+  # that they want to bring over but you could easily just get everything.
+    user.plies.each do |ply|
+      related_model_names = ply.instance_variables.map {|e| e.to_s.gsub("@", "") } & user.model_names
+      related_model_names.each do |name|
+        child = Ply.find_by_oid(ply.send(name.to_sym))
+        unless PlyRelation.where(parent_id: record.id, child_id: child.id).present?
+          ply.children.new(
+            parent_id: ply.id,
+            parent_type: ply.otype,
+            child_id: ply.id,
+            child_type: ply.otype
+            ).save # #create does not work yet.  Sorry
+        end
+      end
+    end
+  end
+end
+```
+
+Now with this setup you can run something like this
+
+```ruby
+SalesforceSynch.call(@user)  # Awesome.  You just imported all your salesforce data.
+
+invoice = Invoice.first => #<Invoice id: 1, user_id: 1, oid: "randomnumber", otype: "Invoice__c",
+# data: {"Id"=>"a00i000000BbWLvAAN", "OwnerId"=>"005i0000002NdyWAAS", "Owner"=>nil...}...>
+
+invoice.line_items => #<ActiveRecord::AssociationRelation [#<Pliable::Ply id: 2 ...>
+
+invoice.line_items.first.invoices.find(invoice.id) === invoice => true
+
+invoice.SalesForceCustomAttribute__c => Whatever it is in salesforce.
+
+Invoice.all => #<ActiveRecord::Relation [#<Invoice id: 136, user_id: 1...>
+
+LineItem.first => #<LineItem id: 145, user_id: 1...>
+
+Invoice.find_by_oid("random_oid_number") => #<Invoice id: 132, user_id: 1, oid: "rand...">
+
+# All the normal active-recordy goodness
+```
+
+## Requirements
+
+## Donating
+Support this project and [others by mfpiccolo][gittip-mfpiccolo] via [gittip][gittip-mfpiccolo].
+
+[gittip-mfpiccolo]: https://www.gittip.com/mfpiccolo/
+
+## Copyright
+
+Copyright (c) 2013 Mike Piccolo
+
+See [LICENSE.txt](LICENSE.txt) for details.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/pliable/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/e1a155a07163d56ca0c4f246c7aa8766 "githalytics.com")](http://githalytics.com/mfpiccolo/pliable)
+
+[license]: https://github.com/mfpiccolo/pliable/MIT-LICENSE
+[homepage]: http://mfpiccolo.github.io/pliable
+[documentation]: http://rdoc.info/github/mfpiccolo/pliable/frames
+[issues]: https://github.com/mfpiccolo/pliable/issues
+

data/Rakefile

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new
+task :doc => :yard
+
+task :default => :test
+

data/lib/generators/pliable/model_generator.rb

@@ -0,0 +1,40 @@
+require "rails/generators/active_record"
+
+module Pliable
+  module Generators
+    class ModelGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      def self.next_migration_number(path)
+        @migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i.to_s
+      end
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def add_initializer
+        create_file "config/initializers/pliable.rb", "Pliable.configure do |config|
+  # define extra scrubbing for ply_name here.  This is for the purpose of making scopes.
+  # For instance, if your models ply name is something like 'Invoice__c'
+  # you will need to gsub '__c' off the end:
+  # config.added_scrubber {|name| name.gsub('__c', '') }
+end"
+      end
+
+      def generate_ply_and_relation_model
+        Rails::Generators.invoke("active_record:model", ["Ply", "--parent", "pliable/ply",  "--no-migration" ])
+      end
+
+      def generate_migration
+        # TODO only run if migration dosn't exist
+        migration_template "migration.rb", "db/migrate/create_plies_and_ply_relations"
+      end
+
+      def run_migrations
+        unless (ActiveRecord::Base.connection.table_exists?('plies') && (ActiveRecord::Base.connection.table_exists? 'ply_relations'))
+          rake("db:migrate db:test:prepare")
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/pliable/templates/migration.rb

@@ -0,0 +1,24 @@
+class CreatePliesAndPlyRelations < ActiveRecord::Migration
+  def change
+    create_table :plies do |t|
+        t.integer  :user_id
+        t.string   :oid
+        t.string   :otype
+        t.json     :data
+        t.hstore   :ohash
+        t.datetime :last_modified
+        t.datetime :last_checked
+
+        t.timestamps
+    end
+
+    create_table :ply_relations do |t|
+      t.integer :parent_id
+      t.string :parent_type
+      t.integer :child_id
+      t.string :child_type
+
+      t.timestamps
+    end
+  end
+end

data/lib/pliable/configure.rb

@@ -0,0 +1,12 @@
+module Pliable
+  module Configure
+
+    def configure
+      yield self if block_given?
+    end
+
+    def added_scrubber(&block)
+      Pliable::Ply.send(:define_method, :added_scrubber, &block)
+    end
+  end
+end

data/lib/pliable/ply.rb

@@ -0,0 +1,89 @@
+require 'active_record'
+
+module Pliable
+  class Ply < ActiveRecord::Base
+    # TODO move to Dummy
+
+    # Allows an ply to associate another ply as either a parent or child
+    has_many :ply_relations
+    has_many :parent_relations, class_name: "PlyRelation", foreign_key: "child_id"
+    has_many :parents, through: :parent_relations, source: :parent
+    has_many :child_relations, class_name: "PlyRelation", foreign_key: "parent_id"
+    has_many :children, through: :child_relations, source: :child
+
+    after_initialize :set_ply_attributes
+    after_initialize :define_ply_scopes
+
+    def self.oldest_last_checked_time
+      order('last_checked').first.last_checked
+    end
+
+    def self.all
+      if current_scope
+        current_scope.clone
+      else
+        if self.name == "Pliable::Ply"
+          scope = relation
+        else
+          if self.try(:ply_type)
+            scope = relation.where(otype: self.try(:ply_type))
+          else
+            scope = relation
+          end
+        end
+        scope.default_scoped = true
+        scope
+      end
+    end
+
+    def self.ply_name(name)
+      define_singleton_method(:ply_type) { name }
+    end
+
+    def to_param
+      oid
+    end
+
+    private
+
+    def set_ply_attributes
+      if data.present?
+        data.each do |key,value|
+          instance_variable_set(('@' + key.to_s).to_sym, value)
+          define_singleton_method(key.to_s) { instance_variable_get(('@' + key.to_s).to_sym) }
+        end
+      end
+    end
+
+    def define_ply_scopes
+      # pluralize is not perfect.  ie. Merchandise__c => merchandises
+      child_names  = children.pluck(:child_type).uniq
+      parent_names = parents.pluck(:parent_type).uniq
+
+      add_scopes(child_names, parent_names)
+    end
+
+    def add_scopes(child_names, parent_names)
+      child_names.each do |name|
+        define_singleton_method(scrub_for_scope(name)) do
+          children.where(otype: name)
+        end
+      end
+
+      parent_names.each do |name|
+        define_singleton_method(scrub_for_scope(name)) do
+          parents.where(otype: name)
+        end
+      end
+    end
+
+    # user initializer to overwrite this method
+    def scrub_for_scope(name)
+      if respond_to? :added_scrubber
+        name = added_scrubber(name)
+      end
+
+      TextHelper.pluralize(name.downcase)
+    end
+  end # Ply
+end # Pliable

data/lib/pliable/ply_relation.rb

@@ -0,0 +1,4 @@
+class PlyRelation < ActiveRecord::Base
+  belongs_to :parent, class_name: 'Ply'
+  belongs_to :child, class_name: 'Ply'
+end

data/lib/pliable/text_helper.rb

@@ -0,0 +1,3 @@
+module TextHelper
+  extend ActiveSupport::Inflector
+end