sanger-jsonapi-resources 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41ebb993c7cbfaceff000cffb66c33e03242eb93f32f898676b78cf633fa835c
-  data.tar.gz: 334f92079b8036bcafcc12647965bc82181a609f3773bd54e88f1041e533f9de
+  metadata.gz: 650cd436866c1e2bd95395039f642430ac9d0f1742e16b6229e4ff6c02749194
+  data.tar.gz: 8617ac86f123744a591f9d669c91e09210ba86840448037d8e087be15a755296
 SHA512:
-  metadata.gz: 8f82eb2c975059c4f0745f08bcf6d9243a48440ae430d9b1f2855386e59d3404dbde639776c114a5e6449788c5be0af766d3d6b4569af2903b1d65fb95169e55
-  data.tar.gz: a423295e281436746d3eecc5edd6ead5377d1ab1ec71ff6322500314eaa45761fc1d5a4b028e4ec18d6b989b33a5c6e240c14b210a1db8c690f61eb11b46cb0d
+  metadata.gz: 9287ea3df53d25721525c1e98b49bcdca8d7c936ec7674b649324a41dcde991e9a2c80cb464d273150710ab9fcf3a758c890788136d4f667552f3e5f0951c655
+  data.tar.gz: d85e68eb490870d9adafa8af7d63d6b7413aeb2c03be43efb510a9d4171b13dab763faff29fcf1610e6ea4ff7dfa4ef72b0530a678ebd4421c56489bdf12a682

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Larry Gebhardt
+Copyright (c) 2014-2021 Cerebris Corporation
 
 MIT License
 

data/README.md

@@ -1,4 +1,6 @@
-# JSONAPI::Resources (Sanger fork)
+# JSONAPI::Resources [![Gem Version](https://badge.fury.io/rb/jsonapi-resources.svg)](https://badge.fury.io/rb/jsonapi-resources) [![Build Status](https://secure.travis-ci.org/cerebris/jsonapi-resources.svg?branch=master)](http://travis-ci.org/cerebris/jsonapi-resources) [![Code Climate](https://codeclimate.com/github/cerebris/jsonapi-resources/badges/gpa.svg)](https://codeclimate.com/github/cerebris/jsonapi-resources)
+
+[![Join the chat at https://gitter.im/cerebris/jsonapi-resources](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cerebris/jsonapi-resources?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 `JSONAPI::Resources`, or "JR", provides a framework for developing an API server that complies with the
 [JSON:API](http://jsonapi.org/) specification.
@@ -11,7 +13,7 @@ backed by ActiveRecord models or by custom objects.
 
 ## Documentation
 
-Full documentation can be found at [http://jsonapi-resources.com](http://jsonapi-resources.com), including the [v0.10 alpha Guide](http://jsonapi-resources.com/v0.10/guide/) specific to this version.
+Full documentation can be found at [http://jsonapi-resources.com](http://jsonapi-resources.com), including the [v0.10 alpha Guide](http://jsonapi-resources.com/v0.10/guide/) specific to this version. 
 
 ## Demo App
 
@@ -20,74 +22,54 @@ We have a simple demo app, called [Peeps](https://github.com/cerebris/peeps), av
 ## Client Libraries
 
 JSON:API maintains a (non-verified) listing of [client libraries](http://jsonapi.org/implementations/#client-libraries)
-which _should_ be compatible with JSON:API compliant server implementations such as JR.
+which *should* be compatible with JSON:API compliant server implementations such as JR.
 
 ## Installation
 
 Add JR to your application's `Gemfile`:
 
-```
+``` 
 gem 'jsonapi-resources'
 ```
 
 And then execute:
 
-```bash
+```bash 
 bundle
 ```
 
 Or install it yourself as:
 
-```bash
+```bash 
 gem install jsonapi-resources
 ```
 
 **For further usage see the [v0.10 alpha Guide](http://jsonapi-resources.com/v0.10/guide/)**
 
-## Sanger-specific release process
-
-There are two versions of the gem which we use for production. The version 1 series has unique customisations and is used by Sequencescape. The version 2 series is a more generic version which is used by Traction.
-
-Check which versions we have published at https://rubygems.org/gems/sanger-jsonapi-resources
-
-### For version 1 series
-
-- Create a branch from **develop**, apply fixes.
-- Change version number in `lib/jsonapi/resources/version.rb` . This file is read by the gemspec during publication.
-- Test Sequencescape with the gem from the branch.
-- Merge the branch into develop.
-<!-- list separator -->
-- Checkout the develop branch.
-- Execute `gem build jsonapi-resources.gemspec` which builds sanger-jsonapi-resources-0.1.x.gem in this case.
-- Execute `gem push sanger-jsonapi-resources-0.1.x.gem` which publishes the gem.
-
-### For version 2 series
-
-- Create a branch from **master**, apply fixes.
-- Change version number in `lib/jsonapi/resources/version.rb` . This file is read by the gemspec during publication.
-- Test Traction with the gem from the branch.
-- Merge the branch into master.
-<!-- list separator -->
-- Checkout the master branch.
-- Execute `gem build jsonapi-resources.gemspec` which builds sanger-jsonapi-resources-0.2.x.gem in this case.
-- Execute `gem push sanger-jsonapi-resources-0.2.x.gem` which publishes the gem.
-
-### Publication
+## Contributing
 
-You will be notified by email for each. You will also receive one email for API key setup. The first push will ask email and password for the account, which are in KeePass (search for "gem").
+1. Submit an issue describing any new features you wish it add or the bug you intend to fix
+1. Fork it ( http://github.com/cerebris/jsonapi-resources/fork )
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Run the full test suite (`rake test`)
+1. Fix any failing tests
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request
 
-> [!TIP]
-> The process above can be improved by creating new releases first and then publish gems from those releases (tags) rather than publications from master (0.2) and develop (0.1) branches. Still create the releases to make tags in this work though.
+## Did you find a bug?
 
-> [!NOTE]
-> The email and password for gem publication is a recent addition to the credentials database. Pull latest changes in the credentials repo.
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/cerebris/jsonapi-resources/issues).
 
-> [!IMPORTANT]
-> Developers need to execute `bundle install`.
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/cerebris/jsonapi-resources/issues/new). 
+Be sure to include a **title and clear description**, as much relevant information as possible, 
+and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
 
-## Contributing
+* If possible, use the relevant bug report templates to create the issue. 
+Simply copy the content of the appropriate template into a .rb file, make the necessary changes to demonstrate the issue, 
+and **paste the content into the issue description or attach as a file**:
+  * [**Rails 5** issues](https://github.com/cerebris/jsonapi-resources/blob/master/lib/bug_report_templates/rails_5_master.rb)
 
-See CONTRIBUTING.md for details.
 
 ## License
 

data/lib/bug_report_templates/rails_5_latest.rb

@@ -0,0 +1,125 @@
+begin
+  require 'bundler/inline'
+rescue LoadError => e
+  STDERR.puts 'Bundler version 1.10 or later is required. Please update your Bundler'
+  raise e
+end
+
+gemfile(true) do
+  source 'https://rubygems.org'
+
+  gem 'rails', require: false
+  gem 'sqlite3', platform: :mri
+
+  gem 'activerecord-jdbcsqlite3-adapter',
+      git: 'https://github.com/jruby/activerecord-jdbc-adapter',
+      branch: 'rails-5',
+      platform: :jruby
+
+  gem 'jsonapi-resources', require: false
+end
+
+# prepare active_record database
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+ActiveRecord::Schema.define do
+  # Add your schema here
+  create_table :your_models, force: true do |t|
+    t.string :name
+  end
+end
+
+# create models
+class YourModel < ActiveRecord::Base
+end
+
+# prepare rails app
+require 'action_controller/railtie'
+# require 'action_view/railtie'
+require 'jsonapi-resources'
+
+class ApplicationController < ActionController::Base
+end
+
+# prepare jsonapi resources and controllers
+class YourModelsController < ApplicationController
+  include JSONAPI::ActsAsResourceController
+end
+
+class YourModelResource < JSONAPI::Resource
+  attribute :name
+  filter :name
+end
+
+class TestApp < Rails::Application
+  config.root = File.dirname(__FILE__)
+  config.logger = Logger.new(STDOUT)
+  Rails.logger = config.logger
+
+  secrets.secret_token = 'secret_token'
+  secrets.secret_key_base = 'secret_key_base'
+
+  config.eager_load = false
+end
+
+# initialize app
+Rails.application.initialize!
+
+JSONAPI.configure do |config|
+  config.json_key_format = :underscored_key
+  config.route_format = :underscored_key
+end
+
+# draw routes
+Rails.application.routes.draw do
+  jsonapi_resources :your_models, only: [:index, :create]
+end
+
+# prepare tests
+require 'minitest/autorun'
+require 'rack/test'
+
+# Replace this with the code necessary to make your test fail.
+class BugTest < Minitest::Test
+  include Rack::Test::Methods
+
+  def json_api_headers
+    {'Accept' => JSONAPI::MEDIA_TYPE, 'CONTENT_TYPE' => JSONAPI::MEDIA_TYPE}
+  end
+
+  def test_index_your_models
+    record = YourModel.create! name: 'John Doe'
+    get '/your_models', nil, json_api_headers
+    assert last_response.ok?
+    json_response = JSON.parse(last_response.body)
+    refute_nil json_response['data']
+    refute_empty json_response['data']
+    refute_empty json_response['data'].first
+    assert record.id.to_s, json_response['data'].first['id']
+    assert 'your_models', json_response['data'].first['type']
+    assert({'name' => 'John Doe'}, json_response['data'].first['attributes'])
+  end
+
+  def test_create_your_models
+    json_request = {
+        'data' => {
+            type: 'your_models',
+            attributes: {
+                name: 'Jane Doe'
+            }
+        }
+    }
+    post '/your_models', json_request.to_json, json_api_headers
+    assert last_response.created?
+    refute_nil YourModel.find_by(name: 'Jane Doe')
+  end
+
+  private
+
+  def app
+    Rails.application
+  end
+end

data/lib/bug_report_templates/rails_5_master.rb

@@ -0,0 +1,140 @@
+begin
+  require 'bundler/inline'
+  require 'bundler'
+rescue LoadError => e
+  STDERR.puts 'Bundler version 1.10 or later is required. Please update your Bundler'
+  raise e
+end
+
+gemfile(true, ui: ENV['SILENT'] ? Bundler::UI::Silent.new : Bundler::UI::Shell.new) do
+  source 'https://rubygems.org'
+
+  gem 'rails', require: false
+  gem 'sqlite3', platform: :mri
+
+  gem 'activerecord-jdbcsqlite3-adapter',
+      git: 'https://github.com/jruby/activerecord-jdbc-adapter',
+      branch: 'rails-5',
+      platform: :jruby
+
+  if ENV['JSONAPI_RESOURCES_PATH']
+    gem 'jsonapi-resources', path: ENV['JSONAPI_RESOURCES_PATH'], require: false
+  else
+    gem 'jsonapi-resources', git: 'https://github.com/cerebris/jsonapi-resources', require: false
+  end
+
+end
+
+# prepare active_record database
+require 'active_record'
+
+class NullLogger < Logger
+  def initialize(*_args)
+  end
+
+  def add(*_args, &_block)
+  end
+end
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.logger = ENV['SILENT'] ? NullLogger.new : Logger.new(STDOUT)
+ActiveRecord::Migration.verbose = !ENV['SILENT']
+
+ActiveRecord::Schema.define do
+  # Add your schema here
+  create_table :your_models, force: true do |t|
+    t.string :name
+  end
+end
+
+# create models
+class YourModel < ActiveRecord::Base
+end
+
+# prepare rails app
+require 'action_controller/railtie'
+# require 'action_view/railtie'
+require 'jsonapi-resources'
+
+class ApplicationController < ActionController::Base
+end
+
+# prepare jsonapi resources and controllers
+class YourModelsController < ApplicationController
+  include JSONAPI::ActsAsResourceController
+end
+
+class YourModelResource < JSONAPI::Resource
+  attribute :name
+  filter :name
+end
+
+class TestApp < Rails::Application
+  config.root = File.dirname(__FILE__)
+  config.logger = ENV['SILENT'] ? NullLogger.new : Logger.new(STDOUT)
+  Rails.logger = config.logger
+
+  secrets.secret_token = 'secret_token'
+  secrets.secret_key_base = 'secret_key_base'
+
+  config.eager_load = false
+end
+
+# initialize app
+Rails.application.initialize!
+
+JSONAPI.configure do |config|
+  config.json_key_format = :underscored_key
+  config.route_format = :underscored_key
+end
+
+# draw routes
+Rails.application.routes.draw do
+  jsonapi_resources :your_models, only: [:index, :create]
+end
+
+# prepare tests
+require 'minitest/autorun'
+require 'rack/test'
+
+# Replace this with the code necessary to make your test fail.
+class BugTest < Minitest::Test
+  include Rack::Test::Methods
+
+  def json_api_headers
+    {'Accept' => JSONAPI::MEDIA_TYPE, 'CONTENT_TYPE' => JSONAPI::MEDIA_TYPE}
+  end
+
+  def test_index_your_models
+    record = YourModel.create! name: 'John Doe'
+    get '/your_models', nil, json_api_headers
+    assert last_response.ok?
+    json_response = JSON.parse(last_response.body)
+    refute_nil json_response['data']
+    refute_empty json_response['data']
+    refute_empty json_response['data'].first
+    assert record.id.to_s, json_response['data'].first['id']
+    assert 'your_models', json_response['data'].first['type']
+    assert({'name' => 'John Doe'}, json_response['data'].first['attributes'])
+  end
+
+  def test_create_your_models
+    json_request = {
+        'data' => {
+            type: 'your_models',
+            attributes: {
+                name: 'Jane Doe'
+            }
+        }
+    }
+    post '/your_models', json_request.to_json, json_api_headers
+    assert last_response.created?
+    refute_nil YourModel.find_by(name: 'Jane Doe')
+  end
+
+  private
+
+  def app
+    Rails.application
+  end
+end

data/lib/jsonapi/active_relation/adapters/join_left_active_record_adapter.rb

@@ -0,0 +1,26 @@
+module JSONAPI
+  module ActiveRelation
+    module Adapters
+      module JoinLeftActiveRecordAdapter
+        # Extends left_joins functionality to rails 4, and uses the same logic for rails 5.0.x and 5.1.x
+        # The default left_joins logic of rails 5.2.x is used. This results in and extra join in some cases. For
+        # example Post.joins(:comments).joins_left(comments: :author) will join the comments table twice,
+        # once inner and once left in 5.2, but only as inner in earlier versions.
+        def joins_left(*columns)
+          if Rails::VERSION::MAJOR >= 6 || (Rails::VERSION::MAJOR >= 5 && ActiveRecord::VERSION::MINOR >= 2)
+            left_joins(columns)
+          else
+            join_dependency = ActiveRecord::Associations::JoinDependency.new(self, columns, [])
+            joins(join_dependency)
+          end
+         end
+
+        alias_method :join_left, :joins_left
+      end
+
+      if defined?(ActiveRecord)
+        ActiveRecord::Base.extend JoinLeftActiveRecordAdapter
+      end
+    end
+  end
+end