jsonapi_suite 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c4f03bc7b18125b847fe930ff43153cc530db9b
-  data.tar.gz: 69eb78d9ba6a3b74fdaac59388f40d5426df7f6f
+  metadata.gz: 20c30584db58af555eebe8d795d6f2193db7242a
+  data.tar.gz: fddb3f32da3ea124c97997e08e21ce404e63277d
 SHA512:
-  metadata.gz: fa0191cf19661d72fb6f4325581d11de3ce077eae496581b4a8e28d098eacd66d344706186ad4913e49ccc5740f61c7a0f44d2b8867143d146a85dddbf67e1f8
-  data.tar.gz: 96037711b14731a9b6305addea7f0547bafcac1013a96e5d9054a7e95dd2b24d6fde3d17ed2c041297cd29e65dea106dd814cac9173a15aba83343aa73d593a4
+  metadata.gz: 4436e2b3f93992f3c7e3323724335c7f0ea29f35f0115aaec3c9e7662d4c7340fc6e3f5857c82d899342e0b2a07d43304bf27f63a0e925fa82c50bc341abc403
+  data.tar.gz: b26fde744e318d8375185e5c864bb40ec837c152bc3150c647984d80dff88cb957efe6c54d11d6b56f59bfeab991c7669514d8ad1660145b28e78ca1e146680c

data/README.md

@@ -4,6 +4,18 @@
 
 Easily build jsonapi.org-compatible APIs in Rails.
 
-[View Official Documentation](https://jsonapi-suite.github.io/jsonapi_suite)
+[View Overview Documentation](https://jsonapi-suite.github.io/jsonapi_suite)
+
+[View Tutorial/Sample applications](https://gist.github.com/richmolj/c7f1adca75f614bb71b27f259ff3c37a)
+
+[View YARD documentation](https://jsonapi-suite.github.io/jsonapi_compliable)
+
+[Join the Slack Channel](https://join.slack.com/t/jsonapi-suite/shared_invite/enQtMjkyMTA3MDgxNTQzLWVkMDM3NTlmNTIwODY2YWFkMGNiNzUzZGMzOTY3YmNmZjBhYzIyZWZlZTk4YmI1YTI0Y2M0OTZmZGYwN2QxZjg)
+
+Direct Contact: richmolj@gmail.com
 
 Supports Rails >= 4.1
+
+### Upgrading
+
+When upgrading the [jsonapi_compliable](https://github.com/jsonapi-suite/jsonapi_compliable) dependency to 0.11.x, please see [this note](https://github.com/jsonapi-suite/jsonapi_compliable/blob/master/README.md#upgrading-to-011x)

data/jsonapi_suite.gemspec

@@ -18,12 +18,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rails', ['>= 4.1', '< 6']
+  spec.add_dependency 'actionpack', ['>= 4.1', '< 6']
+  spec.add_dependency 'activesupport', ['>= 4.1', '< 6']
   spec.add_dependency 'strong_resources', '~> 0.6'
-  spec.add_dependency 'jsonapi_compliable', '~> 0.6'
-  spec.add_dependency 'jsonapi_errorable', '~> 0.1'
-  spec.add_dependency 'jsonapi_spec_helpers', '~> 0.3'
-  spec.add_dependency 'nested_attribute_reassignable', '~> 0.6'
+  spec.add_dependency 'jsonapi_compliable', '~> 0.11'
+  spec.add_dependency 'jsonapi_errorable', '~> 0.6'
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/generators/jsonapi_suite/install_generator.rb

@@ -0,0 +1,54 @@
+module JsonapiSuite
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    class_option :'omit-comments',
+      type: :boolean,
+      default: false,
+      aliases: ['-c'],
+      desc: 'Generate without documentation comments'
+
+    desc "This generator boostraps jsonapi-suite with an initialize and controller mixin"
+    def create_initializer
+      to = File.join('config/initializers', 'jsonapi.rb')
+      template('initializer.rb.erb', to)
+
+      to = File.join('config/initializers', "strong_resources.rb")
+      template('strong_resources.rb.erb', to)
+
+      inject_into_file 'app/controllers/application_controller.rb', after: "class ApplicationController < ActionController::API\n" do
+        app_controller_code
+      end
+
+      inject_into_file 'app/controllers/application_controller.rb', after: "class ApplicationController < ActionController::Base\n" do
+        app_controller_code
+      end
+    end
+
+    private
+
+    def app_controller_code
+      str = ""
+      unless omit_comments?
+        str << "  # Bootstrap jsonapi_suite with relevant modules\n"
+      end
+      str << "  include JsonapiSuite::ControllerMixin\n"
+      str << "\n"
+      str << "  register_exception JsonapiCompliable::Errors::RecordNotFound,\n"
+      str << "    status: 404\n"
+      str << "\n"
+      unless omit_comments?
+        str << "  # Catch all exceptions and render a JSONAPI-compliable error payload\n"
+        str << "  # For additional documentation, see https://jsonapi-suite.github.io/jsonapi_errorable\n"
+      end
+      str << "  rescue_from Exception do |e|\n"
+      str << "    handle_exception(e)\n"
+      str << "  end\n\n"
+      str
+    end
+
+    def omit_comments?
+      !!@options['omit-comments']
+    end
+  end
+end

data/lib/generators/jsonapi_suite/templates/initializer.rb.erb

@@ -0,0 +1,7 @@
+<%- unless omit_comments? -%>
+# Require any adapters your app needs. Since you are using Rails,
+# we'll start you off with ActiveRecord adapter.
+#
+# For further documentation on adapters, see https://jsonapi-suite.github.io/jsonapi_compliable/JsonapiCompliable/Adapters/Abstract.html
+<%- end -%>
+require 'jsonapi_compliable/adapters/active_record'

data/lib/generators/jsonapi_suite/templates/strong_resources.rb.erb

@@ -0,0 +1,36 @@
+<%- unless omit_comments? -%>
+# Define payloads that can be re-used across endpoints.
+#
+# For instance, you may create Tag objects via the /tags endpoint.
+# You may also sidepost Tag objects via the /posts endpoint.
+# Here is where the Tag payload can be defined. For example:
+#
+# strong_resource :tag do
+#   attribute :name, :string
+#   attribute :active, :boolean
+# end
+#
+# You can now reference this payload across controllers:
+#
+# class TagsController < ApplicationController
+#   strong_resource :tag
+# end
+#
+# class PostsController < ApplicationController
+#   strong_resource :post do
+#     has_many :tags, disassociate: true, destroy: true
+#   end
+# end
+#
+# Custom types can be added here as well:
+# Parameters = ActionController::Parameters
+# strong_param :pet_type, swagger: :string, type: Parameters.enum('Dog', 'Cat')
+#
+# strong_resource :pet do
+#   attribute :type, :pet_type
+# end
+#
+# For additional documentation, see https://jsonapi-suite.github.io/strong_resources
+<%- end -%>
+StrongResources.configure do
+end

data/lib/jsonapi_suite/version.rb

@@ -1,3 +1,3 @@
 module JsonapiSuite
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/jsonapi_suite.rb

@@ -3,7 +3,6 @@ require 'jsonapi/include_directive'
 require 'strong_resources'
 require 'jsonapi_compliable'
 require 'jsonapi_errorable'
-require 'nested_attribute_reassignable'
 
 require "jsonapi_suite/version"
 require "jsonapi_suite/controller_mixin"

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_suite
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Lee Richmond
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-09 00:00:00.000000000 Z
+date: 2018-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -31,21 +31,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
-  name: strong_resources
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
-  name: jsonapi_compliable
+  name: strong_resources
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -59,35 +65,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: jsonapi_errorable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: jsonapi_spec_helpers
+  name: jsonapi_compliable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: nested_attribute_reassignable
+  name: jsonapi_errorable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -160,6 +152,9 @@ files:
 - bin/console
 - bin/setup
 - jsonapi_suite.gemspec
+- lib/generators/jsonapi_suite/install_generator.rb
+- lib/generators/jsonapi_suite/templates/initializer.rb.erb
+- lib/generators/jsonapi_suite/templates/strong_resources.rb.erb
 - lib/jsonapi_suite.rb
 - lib/jsonapi_suite/controller_mixin.rb
 - lib/jsonapi_suite/version.rb
@@ -183,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Collection of gems for jsonapi.org-compatible APIs