graphiti-rb 1.0.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44d6ed1a70a645555aa14f12ec2da127e17ba5cd
+  data.tar.gz: 02681454df9a553eda4285623493c55dcecca72c
+SHA512:
+  metadata.gz: 1bdec95482b5cd25c1ea41175d14b77be860f6b7c2a758bddf9f2eeb65939205834f096ebd313c932026172e40cf8110c5c2d0ae4467b08e4197b2c1060b1c04
+  data.tar.gz: 5b406ea40631a1a2e1890868a0826ef90b18543e8d7a47ab8ebcd9fc49e346f456950fdc6e2ab423f2658c79ca3508f87ec0c3056fe0dcc5075afa946fcfb5b9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/gemfiles/*.lock
+/tmp/
+.byebug_history
+spec/dummy/log/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,20 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+
+script: "bundle exec rake"
+
+install: bundle install --retry=3 --jobs=3
+
+gemfile:
+  - gemfiles/rails_4.gemfile
+  - gemfiles/rails_5.gemfile
+
+deploy:
+  provider: rubygems
+  api_key: $RUBYGEMS_API_KEY
+  gem: graphiti-rb
+  on:
+    tags: true
+    repo: jsonapi-suite/jsonapi_compliable

data/.yardopts

@@ -0,0 +1,2 @@
+--plugin classmethods
+--output-dir docs

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "rails-4" do
+  gem "rails", "~> 4.1"
+  gem 'jsonapi-rails', '~> 0.3.1', require: 'jsonapi/rails'
+  gem 'rspec-rails'
+end
+
+appraise "rails-5" do
+  gem "rails", "~> 5.2"
+  gem 'jsonapi-rails', '~> 0.3.1', require: 'jsonapi/rails'
+  gem 'rspec-rails'
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at spasupuleti4@bloomberg.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in graphiti.gemspec
+gemspec
+
+group :test do
+  gem 'pry'
+  gem 'pry-byebug', platform: [:mri]
+  gem 'appraisal'
+  gem 'guard'
+  gem 'guard-rspec'
+end

data/Guardfile

@@ -0,0 +1,32 @@
+guard :rspec, cmd: "bundle exec rspec --color --format documentation" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+  watch(%r{^spec/(.*)\/?(.*)_spec\.rb$})
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("api/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Venkata Pasupuleti
+
+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,75 @@
+### Graphiti
+
+[![Build Status](https://travis-ci.org/jsonapi-suite/jsonapi_compliable.svg?branch=master)](https://travis-ci.org/jsonapi-suite/jsonapi_compliable)
+
+[JSONAPI Suite Website](https://jsonapi-suite.github.io/jsonapi_suite)
+
+[Documentation](https://jsonapi-suite.github.io/jsonapi_compliable)
+
+Supported Rails versions: >= 4.1
+
+### Upgrading to 0.11.x
+
+Due to a backwards-incompatibility introduced in the underlying
+[jsonapi-rb](http://jsonapi-rb.org) gem, specifying custom serializers
+now works slightly differently.
+
+Before:
+
+```ruby
+# app/serializers/serializable_post.rb
+
+has_many :comments, class: SerializableSpecialComment
+```
+
+and/or
+
+```ruby
+render_jsonapi(post, class: SerializableSpecialPost)
+```
+
+This is now all handled at the controller level:
+
+```ruby
+render_jsonapi(post, class: {
+  Post: SerializableSpecialPost,
+  Comment: SerializableSpecialComment
+})
+```
+
+### Upgrading to 0.10
+
+`sideload_whitelist` has been moved from the resource to the controller:
+
+```diff
+class PostsController < ApplicationController
+  jsonapi resource: PostResource do
+-    sideload_whitelist({ index: [:foo] })
+-  end
++  sideload_whitelist({ index: [:foo] })
+end
+
+# NEW
+```
+
+### Running tests
+
+We support Rails >= 4.1. To do so, we use the [appraisal](https://github.com/thoughtbot/appraisal) gem. So, run:
+
+```bash
+$ bin/appraisal rails-4 bin/rspec
+$ bin/appraisal rails-5 bin/rspec
+```
+
+Or run tests for all versions:
+
+```bash
+$ bin/appraisal bin/rspec
+```
+
+### Generating the Documentation
+
+```bash
+$ yard doc
+$ yard server
+```

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "appraisal"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  if ENV["APPRAISAL_INITIALIZED"]
+    t.pattern = 'spec/integration/rails'
+  end
+end
+
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  task :default => [:spec, :appraisal]
+else
+  task :default => [:spec]
+end

data/bin/appraisal

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'appraisal' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("appraisal", "appraisal")

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphiti-rb"
+
+# 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/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/gemfiles/rails_4.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1"
+gem "jsonapi-rails", "~> 0.3.1", :require => "jsonapi/rails"
+gem "rspec-rails"
+
+group :test do
+  gem "pry"
+  gem "pry-byebug", :platform => [:mri]
+  gem "appraisal"
+  gem "guard"
+  gem "guard-rspec"
+end
+
+gemspec :path => "../"

data/gemfiles/rails_5.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2"
+gem "jsonapi-rails", "~> 0.3.1", :require => "jsonapi/rails"
+gem "rspec-rails"
+
+group :test do
+  gem "pry"
+  gem "pry-byebug", :platform => [:mri]
+  gem "appraisal"
+  gem "guard"
+  gem "guard-rspec"
+end
+
+gemspec :path => "../"

data/graphiti.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphiti/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphiti-rb"
+  spec.version       = Graphiti::VERSION
+  spec.authors       = ["Lee Richmond"]
+  spec.email         = ["richmolj@gmail.com"]
+
+  spec.summary       = %q{Easily build jsonapi.org-compatible APIs}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Pinning this version until backwards-incompatibility is addressed
+  spec.add_dependency 'jsonapi-serializable', '~> 0.3.0'
+  spec.add_dependency 'dry-types', '~> 0.13'
+  spec.add_dependency 'jsonapi_errorable', '~> 0.9'
+  spec.add_dependency 'concurrent-ruby', '~> 1.0'
+
+  spec.add_development_dependency "activerecord", ['>= 4.1', '< 6']
+  spec.add_development_dependency "kaminari", '~> 0.17'
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "activemodel", ['>= 4.1', '< 6']
+  spec.add_development_dependency "jsonapi_spec_helpers", '>= 1.0.alpha.1'
+end

data/lib/generators/jsonapi/resource_generator.rb

@@ -0,0 +1,169 @@
+module Graphiti
+  class ResourceGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+
+    class_option :'omit-comments',
+      type: :boolean,
+      default: false,
+      aliases: ['--omit-comments', '-c'],
+      desc: 'Generate without documentation comments'
+    class_option :'actions',
+      type: :array,
+      default: nil,
+      aliases: ['--actions', '-a'],
+      desc: 'Array of controller actions to support, e.g. "index show destroy"'
+
+    desc "This generator creates a resource file at app/resources, as well as corresponding controller/specs/route/etc"
+    def copy_resource_file
+      unless model_klass
+        raise "You must define a #{class_name} model before generating the corresponding resource."
+      end
+
+      generate_controller
+      generate_application_resource unless application_resource_defined?
+      generate_route
+      generate_resource_specs
+      generate_api_specs
+      generate_resource
+    end
+
+    private
+
+    def actions
+      @options['actions'] || %w(index show create update destroy)
+    end
+
+    def actions?(*methods)
+      methods.any? { |m| actions.include?(m) }
+    end
+
+    def omit_comments?
+      @options['omit-comments']
+    end
+
+    def responders?
+      defined?(Responders)
+    end
+
+    def generate_controller
+      to = File.join('app/controllers', class_path, "#{file_name.pluralize}_controller.rb")
+      template('controller.rb.erb', to)
+    end
+
+    def generate_application_resource
+      to = File.join('app/resources', class_path, "application_resource.rb")
+      template('application_resource.rb.erb', to)
+    end
+
+    def application_resource_defined?
+      'ApplicationResource'.safe_constantize.present?
+    end
+
+    def generate_route
+      code = "      resources :#{type}"
+      code << ", only: [#{actions.map { |a| ":#{a}" }.join(', ')}]" if actions.length < 5
+      code << "\n"
+      inject_into_file 'config/routes.rb', after: "scope path: '/v1' do\n" do
+        code
+      end
+    end
+
+    def generate_resource_specs
+      to = File.join("spec/resources/#{file_name}", class_path, "reads_spec.rb")
+      template('resource_reads_spec.rb.erb', to)
+
+      to = File.join("spec/resources/#{file_name}", class_path, "writes_spec.rb")
+      template('resource_writes_spec.rb.erb', to)
+    end
+
+    def generate_api_specs
+      if actions?('index')
+        to = File.join "spec/api/v1/#{file_name.pluralize}",
+          class_path,
+          "index_spec.rb"
+        template('index_request_spec.rb.erb', to)
+      end
+
+      if actions?('show')
+        to = File.join "spec/api/v1/#{file_name.pluralize}",
+          class_path,
+          "show_spec.rb"
+        template('show_request_spec.rb.erb', to)
+      end
+
+      if actions?('create')
+        to = File.join "spec/api/v1/#{file_name.pluralize}",
+          class_path,
+          "create_spec.rb"
+        template('create_request_spec.rb.erb', to)
+      end
+
+      if actions?('update')
+        to = File.join "spec/api/v1/#{file_name.pluralize}",
+          class_path,
+          "update_spec.rb"
+        template('update_request_spec.rb.erb', to)
+      end
+
+      if actions?('destroy')
+        to = File.join "spec/api/v1/#{file_name.pluralize}",
+          class_path,
+          "destroy_spec.rb"
+        template('destroy_request_spec.rb.erb', to)
+      end
+    end
+
+    def generate_resource
+      to = File.join('app/resources', class_path, "#{file_name}_resource.rb")
+      template('resource.rb.erb', to)
+    end
+
+    def jsonapi_config
+      File.exists?('.jsonapicfg.yml') ? YAML.load_file('.jsonapicfg.yml') : {}
+    end
+
+    def update_config!(attrs)
+      config = jsonapi_config.merge(attrs)
+      File.open('.jsonapicfg.yml', 'w') { |f| f.write(config.to_yaml) }
+    end
+
+    def prompt(header: nil, description: nil, default: nil)
+      say(set_color("\n#{header}", :magenta, :bold)) if header
+      say("\n#{description}") if description
+      answer = ask(set_color("\n(default: #{default}):", :magenta, :bold))
+      answer = default if answer.blank? && default != 'nil'
+      say(set_color("\nGot it!\n", :white, :bold))
+      answer
+    end
+
+    def api_namespace
+      @api_namespace ||= begin
+        ns = jsonapi_config['namespace']
+
+        if ns.blank?
+          ns = prompt \
+            header: "What is your API namespace?",
+            description: "This will be used as a route prefix, e.g. if you want the route '/books_api/v1/authors' your namespace would be 'books_api'",
+            default: 'api'
+          update_config!('namespace' => ns)
+        end
+
+        ns
+      end
+    end
+
+    def model_klass
+      class_name.safe_constantize
+    end
+
+    def resource_klass
+      "#{model_klass}Resource"
+    end
+
+    def type
+      model_klass.name.underscore.pluralize
+    end
+  end
+end