api_client_bulk_loader 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b52e169fa4d30699f1d05bccb728bb24da39004
+  data.tar.gz: 5a7605677dd52caa27ef85a544187807bce9b2d1
+SHA512:
+  metadata.gz: 5b91c1a5b5648d0724356c39c1ca130576c723af4c44acb607680849c743022f3255c6c9db3be6c5429c3bf6c79e63da323aaaa47917a545b9955f066fa80828
+  data.tar.gz: 9665e5686d9b9bf1aebdfa1b7d98f36da80ad7c60c13ca60c174d11616eb7dfbdb9d91b07c9dfc49134349d97263fa68bbd92c4e898713cd60a58950619cca16

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'ApiClientBulkLoader'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/api_client_bulk_loader/api_client_bulk_loader.rb

@@ -0,0 +1,14 @@
+
+module ApiClientBulkLoader
+  module Client
+    autoload :AssociationHelper, 'api_client_bulk_loader/client/association_helper'
+    autoload :AssociationAdapter, 'api_client_bulk_loader/client/association_adapter'
+    autoload :PolymorphicAssociationHelper, 'api_client_bulk_loader/client/polymorphic_association_helper'
+    autoload :PolymorphicAssociationAdapter, 'api_client_bulk_loader/client/polymorphic_association_adapter'
+    autoload :BulkLoadHelper, 'api_client_bulk_loader/client/bulk_load_helper'
+    autoload :Loader, 'api_client_bulk_loader/client/loader'
+  end
+
+end
+
+JsonApiClient::Resource.send(:include, ApiClientBulkLoader::Client::BulkLoadHelper)

data/lib/api_client_bulk_loader/client/association_adapter.rb

@@ -0,0 +1,31 @@
+module ApiClientBulkLoader
+  module Client
+    #Adapts into the bulk loader. Mainly useful for storing the details of the bulk call.
+    class AssociationAdapter
+      attr_reader :resource_model, :attribute, :autoload, :values_from, :limit
+
+      def initialize(res_model, attribute = nil, values_from = nil, autoload = false, is_has_one = false, limit = nil)
+        @resource_model = res_model
+        @attribute = attribute
+        @autoload = autoload
+        @values_from = values_from
+        @has_one = is_has_one
+        @limit = limit
+
+        Thread.current[:bulk_loader] ||= ApiClientBulkLoader::Client::Loader.new
+        @bulk_loader = Thread.current[:bulk_loader]
+      end
+
+      #Fetch.
+      def fetch(values)
+        results = @bulk_loader.fetch(@resource_model, values, @attribute)
+        return @has_one ? results.first : results
+      end
+
+      #Push.
+      def push(values)
+        @bulk_loader.push(@resource_model, values, @attribute)
+      end
+    end
+  end
+end

data/lib/api_client_bulk_loader/client/association_helper.rb

@@ -0,0 +1,60 @@
+module ApiClientBulkLoader
+  module Client
+    #Included in the client base models
+    module AssociationHelper
+      extend ActiveSupport::Concern
+
+      included do 
+        #manually push values into the queue.
+        def self.bulk_queue_values_for_association(values, association)
+          raise Exception.new("Cannot find bulk-enabled association #{association} in class.") unless @bulk_queued_associations[association]
+          @bulk_queued_associations[association].push(values)
+        end
+
+        #Register an association as one to be batch loaded
+        #Required:
+        # association - the association that is being bulk loaded.
+        # api_client_model - the model to fetch the association with (what you call .find on)
+        #Optional
+        # attribute - The attribute of the associated model to search by. Defults to id. This could be used to query by an FK - If you have a User class and a user has many Cars, then under User you could do
+        #     bulk_load :cars, Client::Cars, attribute: user_id
+        #     This would cause user.cars to trigger a query of cars.json?user_id=<the users id> instead of the default cars.json?ids=[user.car_ids]
+        #     Use this when the length of .<>_ids exceeds the uri length limit.
+        # from - The attribute of the client model to use to fetch values. eg. :assoc_ids 
+        # autoload - if the ids for the association will be queued on the item's initialization. Else, you call obj.queue_association(:assoc_to_load) manually.
+        # is_has_one - Overrides the default of returning an array for the association, instead it returns the first item.
+
+        def self.bulk_load(association, api_client_model, attribute: :id, autoload: false, from: :id, is_has_one: false, limit: nil)
+          @bulk_queued_associations ||= {}
+          @bulk_queued_associations[association] = ApiClientBulkLoader::Client::AssociationAdapter.new(api_client_model, attribute, from, autoload, is_has_one, limit)
+
+          define_bulk_method(association)
+        end
+
+        #Shorthand to the above, but automatically sets 'is_has_one' to true.
+        def self.bulk_load_has_one(*args, **kwargs)
+          self.bulk_load(*args,**kwargs.merge({is_has_one: true}))
+        end
+
+        def queue_association(association, limit = nil)
+          adapter = self.class.bulk_queued_associations[association]
+          #Probably just raise an exception if it doesnt respond to the target.
+          values = Array(self.send(adapter.values_from))
+          limit = limit || adapter.limit
+
+          values = values.first(limit) if limit.present?
+
+
+          if !values.nil?
+            adapter.push(values)
+            self.instance_variable_set("@#{association}", ->{
+              adapter.fetch(values)
+            })
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/api_client_bulk_loader/client/bulk_load_helper.rb

@@ -0,0 +1,46 @@
+module ApiClientBulkLoader
+  module Client
+    #Included in the client base models
+    module BulkLoadHelper
+      extend ActiveSupport::Concern
+
+      included do 
+
+        include AssociationHelper
+        include PolymorphicAssociationHelper
+
+        #Getter for registered association load queues
+        def self.bulk_queued_associations
+          @bulk_queued_associations
+        end
+
+        def self.define_bulk_method(association)
+          #define new getter for assoc that uses the proc
+          define_method association.to_s do 
+            ivar = self.instance_variable_get("@#{association}")
+            if (ivar.is_a? Proc)
+              self.instance_variable_set("@#{association}", ivar.call)
+            else
+              ivar
+            end
+          end
+        end
+
+        def initialize(*args)
+          super(*args)
+          #Skip em unless we got em
+          return self unless self.class.bulk_queued_associations
+          self.class.bulk_queued_associations.each do |assoc, adapter|
+            if adapter.class == ApiClientBulkLoader::Client::PolymorphicAssociationAdapter
+              self.queue_poly_association(assoc) if adapter.autoload
+            else
+              self.queue_association(assoc) if adapter.autoload
+            end
+          end
+
+          return self
+        end
+      end
+    end
+  end
+end

data/lib/api_client_bulk_loader/client/loader.rb

@@ -0,0 +1,79 @@
+module ApiClientBulkLoader
+  module Client
+    #Storage class for our bulk loading. Is one per thread. 
+    class Loader
+      def initialize()
+        #Hash with keys being a client model, pointing to hashes with id's as keys and loaded objects as values.
+        @model_store = {}
+
+        #Contains each bulk stored model, then containing the attribute to be queried by which then holds an array of values that have yet to be fetched
+        @queued_model_store = {}
+
+        #Contains a structure similar to queued model store, but stores which values have already been queried.
+        @checked_model_store = {}
+      end
+
+      #Push the values into the appropriate queue store, only if they haven't been run.
+      def push(model, values, attribute = :id)
+        # Idempotent.
+        create_model_attribute_store(model, attribute)
+
+        # Eliminate those that have already been checked
+        values -= @checked_model_store[model][attribute] if(@checked_model_store[model][attribute])
+
+        # or in those values to the queue store.
+        @queued_model_store[model][attribute] |= values
+      end
+
+      #Fetch the values, given the adapter that pertains to those values. 
+      def fetch(model, values, attribute = :id)
+        #If any of these values are in the queue, we have to retrieve it.
+        retrieve_model_by_attribute!(model, attribute) unless (values & @queued_model_store[model][attribute]).empty?
+
+        #Return all values for keys matching our value(s)
+        return  @model_store[model].values_at(*values).compact || []
+      end
+
+      private
+
+      #For a model's attribute, fetch all records matching the values in the queue.
+      def retrieve_model_by_attribute!(model, attribute)
+        return [] unless @queued_model_store[model][attribute]
+        #Get our values from the queue and make the call to the client model
+
+        values = @queued_model_store[model][attribute]
+
+        results = if attribute != :id #Index the returned results by the attribute used to query by
+
+          Array(model.find(attribute => values)).group_by{|obj| obj.send(attribute) }
+
+        else #Index the results by their ids.
+
+          Hash[ Array(model.find(values)).map{|obj| [obj.id, obj]} ]
+
+        end
+
+        #Merge the results in with what we may already have.
+        @model_store[model] = @model_store[model].merge(results)
+
+        #Register these values as being checked
+        @checked_model_store[model][attribute] |= values
+        #Clear the queue
+        @queued_model_store[model][attribute] = []
+      end
+
+      def create_model_attribute_store(model, attribute)
+        #base hash for the model
+        @queued_model_store[model] ||= {}
+        @checked_model_store[model] ||= {}
+
+        #For criteria to be loaded by an attribute
+        @queued_model_store[model][attribute] ||= []
+        #For checking if criteria has already been run.
+        @checked_model_store[model][attribute] ||= []
+        #For storing by id.
+        @model_store[model] ||= {}
+      end
+    end
+  end
+end

data/lib/api_client_bulk_loader/client/polymorphic_association_adapter.rb

@@ -0,0 +1,32 @@
+module ApiClientBulkLoader
+  module Client
+    #Adapts into the bulk loader. Mainly useful for storing the details of the bulk call.
+    class PolymorphicAssociationAdapter
+      attr_reader :resource_translation, :attribute, :autoload, :type_from, :values_from, :limit
+
+      def initialize(resource_translation, attribute = nil, type_from = nil, values_from = nil, autoload = false, is_has_one = false, limit = nil)
+        @resource_translation = resource_translation
+        @attribute = attribute
+        @autoload = autoload
+        @values_from = values_from
+        @type_from = type_from
+        @has_one = is_has_one
+        @limit = limit
+
+        Thread.current[:bulk_loader] ||= ApiClientBulkLoader::Client::Loader.new
+        @bulk_loader = Thread.current[:bulk_loader]
+      end
+
+      #Fetch.
+      def fetch(values, resource_type)
+        results = @bulk_loader.fetch(@resource_translation[resource_type], values, @attribute)
+        return @has_one ? results.first : results
+      end
+
+      #Push.
+      def push(values, resource_type)
+        @bulk_loader.push(@resource_translation[resource_type], values, @attribute)
+      end
+    end
+  end
+end

data/lib/api_client_bulk_loader/client/polymorphic_association_helper.rb

@@ -0,0 +1,63 @@
+module ApiClientBulkLoader
+  module Client
+    #Included in the client base models
+    module PolymorphicAssociationHelper
+      extend ActiveSupport::Concern
+
+      included do 
+
+        #manually push values into the queue.
+        def self.bulk_queue_poly_values_for_association(resource_model, values, association)
+          raise Exception.new("Cannot find bulk-enabled association #{association} in class.") unless @bulk_queued_associations[association]
+          @bulk_queued_associations[association].push(values,resource_model)
+        end
+
+        #Register a polymorphic association as one to be batch loaded
+        #Required:
+        # association - the association that is being bulk loaded.
+        # type_model_hash - a hash mapping the possible values for type to their respective client endpoints
+        #Optional
+        # attribute - The attribute of the associated model to search by. Defults to id. This could be used to query by an FK - If you have a User class and a user has many Cars, then under User you could do
+        #     bulk_load :cars, Client::Cars, attribute: user_id
+        #     This would cause user.cars to trigger a query of cars.json?user_id=<the users id> instead of the default cars.json?ids=[user.car_ids]
+        #     Use this when the length of .<>_ids exceeds the uri length limit.
+        # from - The attribute of the client model to use to fetch values. eg. :assoc_ids 
+        # type_from - The attribute of the client model to use to fetch the polymorphic type
+        # autoload - if the ids for the association will be queued on the item's initialization. Else, you call obj.queue_association(:assoc_to_load) manually.
+        # is_has_one - Overrides the default of returning an array for the association, instead it returns the first item.
+
+
+        def self.bulk_load_poly(association, type_model_hash, attribute: :id, autoload: false, type_from: :document_type, from: :document_id, is_has_one: false, limit: nil)
+          @bulk_queued_associations ||= {}
+          @bulk_queued_associations[association] = ApiClientBulkLoader::Client::PolymorphicAssociationAdapter.new(type_model_hash, attribute,type_from, from, autoload, is_has_one, limit)
+
+          define_bulk_method(association)
+        end
+
+        def self.bulk_load_poly_has_one(*args, **kwargs)
+          self.bulk_load_poly(*args,**kwargs.merge({is_has_one: true}))
+        end
+
+        def queue_poly_association(association, limit = nil)
+          adapter = self.class.bulk_queued_associations[association]
+          #Probably just raise an exception if it doesnt respond to the target.
+          values = Array(self.send(adapter.values_from))
+          resource_type = self.send(adapter.type_from)
+          limit = limit || adapter.limit
+
+          values = values.first(limit) if limit.present?
+
+
+          if !values.nil?
+            adapter.push(values, resource_type)
+            self.instance_variable_set("@#{association}", ->{
+              adapter.fetch(values, resource_type)
+            })
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/api_client_bulk_loader/version.rb

@@ -0,0 +1,3 @@
+module ApiClientBulkLoader
+  VERSION = "0.1.3"
+end

data/lib/api_client_bulk_loader.rb

@@ -0,0 +1,4 @@
+require 'rails'
+require 'json_api_client'
+
+require "api_client_bulk_loader/api_client_bulk_loader"

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/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/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/variant_objects_controller.rb

@@ -0,0 +1,10 @@
+class VariantObjectsController < ApplicationController
+
+  def index
+    @variant_objects = VariantObject.all
+
+    if(params[:variant])
+      @variant = params[:variant]
+    end
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/variant_object.rb

@@ -0,0 +1,2 @@
+class VariantObject < ActiveRecord::Base
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/variant_objects/_variant_object.html.erb

@@ -0,0 +1 @@
+<h1 class="default_template"><%= variant_object.name %></h1>

data/test/dummy/app/views/variant_objects/_variant_object_medium.html.erb

@@ -0,0 +1 @@
+<h2 class="medium_template"><%= variant_object.name %></h2>

data/test/dummy/app/views/variant_objects/_variant_object_small.html.erb

@@ -0,0 +1 @@
+<h3 class="small_template"><%= variant_object.name %></h3>

data/test/dummy/app/views/variant_objects/index.html.erb

@@ -0,0 +1,24 @@
+<div id="test_disp_container">
+	<% if @variant %>
+
+		<%= render @variant_objects, :variant => @variant %>
+		<hr/>
+		<% @variant_objects.each do |variant_object| %>
+			<%= render :partial=> variant_object, :variant => @variant  %>
+			<br/>
+			<%= render variant_object, :variant => @variant  %>
+		<% end %>
+
+	<% else %>
+		<%= render @variant_objects %>
+		<hr/>
+		<% @variant_objects.each do |variant_object| %>
+			<%= render :partial=> variant_object %>
+			<br/>
+			<%= render variant_object %>
+		<% end %>
+	<% end %>
+	<% if params[:test_nil_path] %>
+		<%= render  %>
+	<% end %>
+</div>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "render_variant"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end