json_api_resource_adapters 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93572f345844bba1fb90020222f7d8350ed9671c
-  data.tar.gz: f3c0e4570931243f88e4836d16a3acdaf2211c4c
+  metadata.gz: 7ce8914f0c409d7e0d93d7ab672bf12b648ed85a
+  data.tar.gz: c08ef916dc16f49df84a5699ca5cf8bf2966ffa7
 SHA512:
-  metadata.gz: 0e0b2e0283c2e827aeb1580c5d9f930e2a11f4264f4eee63fc6eab646b1ddd71635f0d8379183a7ff02cf62a5afbef9db084cb8867eeac5a21e69ff54c203e33
-  data.tar.gz: 1d7748ba94f508edbf5f21c6607c27f90bb13fbe661cbf4d4a04b5bba95f9172e0a976429b25a68c489bef1709ea393dfa44fd812624e35b6dac66aa04289661
+  metadata.gz: 3a489f9cd93b8334aada20a7cc3e50c230c92d7149a2c5247225e3c3266851ea227ba686eb428e242af5d500e9ff864749b59c253c9d3e66ade5a212ed09f454
+  data.tar.gz: b756bd8d9393f3303403652e405765f6d957385431fc8e546ed6ed12e76d3921035bef229ccd8bcfd4f3c7b8a8a63c054e7c0b3fc5ea49824748bd28f4d024b8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Greg
+
+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,58 @@
+# JsonApiResourceAdapters
+
+A collection of handy adapters for projects tha use [JsonApiResource](http://github.com/avvo/json_api_resource)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_api_resource_adapters'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_api_resource_adapters
+
+## Usage
+
+Include the gem and you will have access to 
+
+### Autobots::JsonApiResourceAssembler
+
+This is an adapter for [autobots](https://github.com/chingor13/autobots) that allows autobots to bulk fetch records for caching.
+
+The setup is pretty simple:
+
+```ruby
+module MyApi
+  module V1
+    class MyAssembler < Autobots::JsonApiResourceAssembler
+
+      self.cache = Rails.cache
+
+    end
+  end
+end
+
+```
+
+### Elasticsearch adapter
+
+This is an adapter for [elasticsearch-model](https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-model)
+
+There's nothing you have to do. It will autoload and let you call interacr with your resource class the same way you would with an ActiveRecord model
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gaorlov/json_api_resource_adapters.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_api_resource_adapters"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json_api_resource_adapters.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_api_resource_adapters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_api_resource_adapters"
+  spec.version       = JsonApiResourceAdapters::VERSION
+  spec.authors       = ["Greg"]
+  spec.email         = ["greg@avvo.com"]
+
+  spec.summary       = "Various adapters for JsonApiResource"
+  spec.description   = "Adapters for JsonApiResource: Autobots preloading; Elasticsearch"
+  spec.homepage      = "https://github.com/gaorlov/json_api_resource_adapters"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "json_api_resource"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/autobots/json_api_resource_assembler.rb

@@ -0,0 +1,11 @@
+module Autobots
+  class JsonApiResourceAssembler < Assembler
+    class_attribute :preloads
+    self.preloads = []
+    
+    def transform( objects )
+      JsonApiResource::Associations::Preloader.preload(objects, preloads)
+      objects
+    end
+  end
+end

data/lib/autobots.rb

@@ -0,0 +1,3 @@
+module Autobots
+  autoload :JsonApiResourceAssembler, "autobots/json_api_resource_assembler"
+end

data/lib/elasticsearch/model/adapter/adapter.rb

@@ -0,0 +1,7 @@
+module Elasticsearch
+  module Model
+    module Adapter
+      autoload :JsonApiResource,  'elasticsearch/model/adapter/json_api_resource'
+    end
+  end
+end

data/lib/elasticsearch/model/adapter/json_api_resource.rb

@@ -0,0 +1,70 @@
+module Elasticsearch
+  module Model
+    module Adapter
+
+      # An adapter for JsonApiResource-based models
+      #
+      module JsonApiResource
+
+        Adapter.register self,
+                         lambda { |klass| !!defined?(::JsonApiResource::Resource) && klass.respond_to?(:ancestors) && klass.ancestors.include?(::JsonApiResource::Resource) }
+
+        module Records
+          attr_writer :options
+
+          def options
+            @options ||= {}
+          end
+
+          # Returns an array of `JsonApiResource::Resource`
+          #
+          def records
+            klass.where(id: ids, skip_pagination: true, order: "field(id, #{ids.join(", ")})")
+          end
+        end
+
+        module Callbacks
+
+          # Handle index updates (creating, updating or deleting documents)
+          # when the model changes, by hooking into the lifecycle
+          #
+          # @see http://guides.rubyonrails.org/active_record_callbacks.html
+          #
+          def self.included(base)
+            base.class_eval do
+              after_commit lambda { __elasticsearch__.index_document  },  on: :create
+              after_commit lambda { __elasticsearch__.update_document },  on: :update
+              after_commit lambda { __elasticsearch__.delete_document },  on: :destroy
+            end
+          end
+        end
+
+        module Importing
+
+          # Fetch batches of records from the database (used by the import method)
+          #
+          #
+          # @see http://api.rubyonrails.org/classes/AcriveRecord/Batches.html AcriveRecord::Batches.find_in_batches
+          #
+          def __find_in_batches(options={}, &block)
+            page = 1
+            loop do
+              objects = where page: page, per_page: 100
+              
+              yield objects
+
+              page +=1
+
+              break if page >= objects.meta[:total_pages]
+
+            end
+          end
+
+          def __transform
+            lambda { |model|  { index: { _id: model.id, data: model.__elasticsearch__.as_indexed_json } } }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/model/model.rb

@@ -0,0 +1,5 @@
+module Elasticsearch
+  module Model
+    autoload :Adapter,  'elasticsearch/model/adapter'
+  end
+end

data/lib/elasticsearch.rb

@@ -0,0 +1,3 @@
+module Elasticsearch
+  autoload :Model, 'elasticsearch/model'
+end

data/lib/json_api_resource_adapters/version.rb

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

data/lib/json_api_resource_adapters.rb

@@ -0,0 +1,15 @@
+require "json_api_resource_adapters/version"
+
+puts "loading adapters"
+if defined? Autobots
+  # bluk loader adapter for the autobots assembler
+  autoload :Autobots,         "autobots"
+end
+
+if defined? Elasticsearch
+  # import and result retreival adapter for elasticsearch
+  autoload :Elasticsearch,    "elasticsearch"
+end
+
+module JsonApiResourceAdapters
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_api_resource_adapters
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Greg
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_api_resource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,7 +72,24 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_api_resource_adapters.gemspec
+- lib/autobots.rb
+- lib/autobots/json_api_resource_assembler.rb
+- lib/elasticsearch.rb
+- lib/elasticsearch/model/adapter/adapter.rb
+- lib/elasticsearch/model/adapter/json_api_resource.rb
+- lib/elasticsearch/model/model.rb
+- lib/json_api_resource_adapters.rb
+- lib/json_api_resource_adapters/version.rb
 homepage: https://github.com/gaorlov/json_api_resource_adapters
 licenses:
 - MIT