graphiti 1.0.alpha.1 → 1.0.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ca5c32df5a0a64e436b786d26cbe51074d18dc4
-  data.tar.gz: c9ddad6eb9c3586ec3c7f9568696c7776c508834
+  metadata.gz: 736b8601bf09408a0fa6ed8f2a0c148a79f7c285
+  data.tar.gz: 9b0adbc770aea3e609f15804db1b33ddba1dee13
 SHA512:
-  metadata.gz: 29bbb74fac76a93090f94e08cf38c0021bbd531d31979dbb4a1ba720ebd366df02b7f3b4fa405c1a5a743db8fe85c71cfb608b24610f1d5378d31a769441b24c
-  data.tar.gz: 022b06dc74a994896b1c6478a716a540f04218071f7cd5baeab44fcb1d2c67a38aef385842ae8aeeb65226db02c70941f33fe8676a6c2d96185a89a2e262d21c
+  metadata.gz: 467e32b7154d37819d6bc4598872e66f3a138120ea2781253238ce4b6fc426b416184c79e5ce58a6d9b596b5754cc87bf7ffb2fc02ab2867bdc6eb00edbe8939
+  data.tar.gz: c8ec00841469671ef261283f3dd6f556c095742be04d31f1bfa9d633ee5066cd009a790560bc65a61845b6d2db366cff5aa2da7b0226e0a4a2ff7146677c2b78

data/.travis.yml

@@ -10,11 +10,3 @@ 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/README.md

@@ -1,75 +1,5 @@
 ### Graphiti
 
-[![Build Status](https://travis-ci.org/jsonapi-suite/jsonapi_compliable.svg?branch=master)](https://travis-ci.org/jsonapi-suite/jsonapi_compliable)
+![Build Status](https://travis-ci.org/graphiti-api/graphiti.svg?branch=master)
 
-[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
-```
+A stylish alternative to GraphQL.

data/bin/console

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

data/exe/graphiti

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'graphiti/cli'
+
+Graphiti::CLI.start(ARGV)

data/graphiti.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   # 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 'graphiti_errors', '~> 1.0.alpha.2'
   spec.add_dependency 'concurrent-ruby', '~> 1.0'
 
   spec.add_development_dependency "activerecord", ['>= 4.1', '< 6']
@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency "graphiti_spec_helpers", '>= 1.0.alpha.1'
 end

data/lib/generators/jsonapi/resource_generator.rb

@@ -1,4 +1,4 @@
-module Graphiti
+module Jsonapi
   class ResourceGenerator < ::Rails::Generators::NamedBase
     source_root File.expand_path('../templates', __FILE__)
 

data/lib/generators/jsonapi/templates/application_resource.rb.erb

@@ -2,13 +2,11 @@
 # ApplicationResource is similar to ApplicationRecord - a base class that
 # holds configuration/methods for subclasses.
 # All Resources should inherit from ApplicationResource.
-# Resource documentation: https://jsonapi-suite.github.io/jsonapi_compliable/JsonapiCompliable/Resource.html
 <%- end -%>
 class ApplicationResource < Graphiti::Resource
   <%- unless omit_comments? -%>
   # Use the ActiveRecord Adapter for all subclasses.
   # Subclasses can still override this default.
-  # More on adapters: https://jsonapi-suite.github.io/jsonapi_compliable/JsonapiCompliable/Adapters/Abstract.html
   <%- end -%>
   self.abstract_class = true
   self.adapter = Graphiti::Adapters::ActiveRecord::Base.new

data/lib/graphiti.rb

@@ -7,7 +7,7 @@ require 'active_support/concern'
 require 'active_support/time'
 
 require 'dry-types'
-require 'jsonapi_errorable'
+require 'graphiti_errors'
 
 require 'jsonapi/serializable'
 
@@ -17,8 +17,11 @@ require "graphiti/configuration"
 require "graphiti/context"
 require "graphiti/errors"
 require "graphiti/types"
+require "graphiti/schema"
+require "graphiti/schema_diff"
 require "graphiti/adapters/abstract"
 require "graphiti/resource/sideloading"
+require "graphiti/resource/links"
 require "graphiti/resource/configuration"
 require "graphiti/resource/dsl"
 require "graphiti/resource/interface"
@@ -56,6 +59,9 @@ require "graphiti/util/sideload"
 require "graphiti/util/hooks"
 require "graphiti/util/attribute_check"
 require "graphiti/util/serializer_attributes"
+require "graphiti/util/serializer_relationships"
+require "graphiti/util/class"
+require "graphiti/util/link"
 
 require 'graphiti/adapters/null'
 
@@ -116,6 +122,16 @@ module Graphiti
   def self.configure
     yield config
   end
+
+  def self.resources
+    @resources ||= []
+  end
+
+  def self.check!
+    resources.each do |resource|
+      resource.sideloads.values.each(&:check!)
+    end
+  end
 end
 
 require "graphiti/runner"

data/lib/graphiti/adapters/abstract.rb

@@ -76,6 +76,30 @@ module Graphiti
     # @see Adapters::ActiveRecordSideloading
     # @see Adapters::Null
     class Abstract
+      def default_operators
+        {
+          string: [
+            :eq,
+            :not_eq,
+            :eql,
+            :not_eql,
+            :prefix,
+            :not_prefix,
+            :suffix,
+            :not_suffix,
+            :match,
+            :not_match
+          ],
+          integer_id: numerical_operators,
+          integer: numerical_operators,
+          big_decimal: numerical_operators,
+          float: numerical_operators,
+          boolean: [:eq],
+          date: numerical_operators,
+          datetime: numerical_operators
+        }
+      end
+
       def filter_string_eq(scope, attribute, value)
         raise Errors::AdapterNotImplemented.new(self, attribute, :filter_string_eq)
       end
@@ -378,6 +402,10 @@ module Graphiti
         scope
       end
 
+      def belongs_to_many_filter(sideload, scope, value)
+        raise 'You must implement #belongs_to_many_filter in an adapter subclass'
+      end
+
       def associate_all(parent, children, association_name, association_type)
         if activerecord_associate?(parent, children[0], association_name)
           activerecord_adapter.associate_all parent,
@@ -500,6 +528,10 @@ module Graphiti
 
       private
 
+      def numerical_operators
+        [:eq, :not_eq, :gt, :gte, :lt, :lte]
+      end
+
       def activerecord_adapter
         @activerecord_adapter ||=
           ::Graphiti::Adapters::ActiveRecord::Base.new

data/lib/graphiti/adapters/active_record/base.rb

@@ -189,6 +189,14 @@ module Graphiti
           }
         end
 
+        def belongs_to_many_filter(sideload, scope, value)
+          scope
+            .includes(sideload.through_relationship_name)
+            .where(sideload.through_table_name => {
+              sideload.true_foreign_key => value
+            })
+        end
+
         def associate_all(parent, children, association_name, association_type)
           association = parent.association(association_name)
           association.loaded!

data/lib/graphiti/adapters/active_record/many_to_many_sideload.rb

@@ -2,20 +2,13 @@ module Graphiti
   module Adapters
     module ActiveRecord
       class ManyToManySideload < Sideload::ManyToMany
-        def default_base_scope
-          resource_class.model.all
-        end
-
         def through_table_name
           @through_table_name ||= parent_resource_class.model
             .reflections[through.to_s].klass.table_name
         end
 
-        def scope(parent_ids)
-          base_scope
-            .includes(through)
-            .where(through_table_name => { true_foreign_key => parent_ids })
-            .distinct
+        def through_relationship_name
+          foreign_key.keys.first
         end
 
         def infer_foreign_key

data/lib/graphiti/cli.rb

@@ -0,0 +1,45 @@
+require 'thor'
+require 'net/http'
+require 'graphiti'
+
+Thor::Base.shell = Thor::Shell::Color
+
+module Graphiti
+  class CLI < Thor
+    desc 'schema_check OLD_SCHEMA NEW_SCHEMA', 'Diff 2 schemas for backwards incompatibilities. Pass file path or URL. If your app relies on JSON Web Tokens, you can set GRAPHITI_TOKEN for authentication'
+    def schema_check(old, new)
+      old = schema_for(old)
+      new = schema_for(new)
+
+      errors = Graphiti::SchemaDiff.new(old, new).compare
+      if errors.any?
+        say(set_color("Backwards incompatibilties found!\n", :red, :bold))
+        errors.each { |e| say(set_color(e, :yellow)) }
+        exit(1)
+      else
+        say(set_color("No incompatibilities found!", :green))
+        exit(0)
+      end
+    end
+
+    private
+
+    def schema_for(input)
+      if input.starts_with?('http')
+        JSON.parse(fetch_remote_schema(input))
+      else
+        JSON.parse(File.read(input))
+      end
+    end
+
+    def fetch_remote_schema(path)
+      uri = URI(path)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == 'https'
+      req = Net::HTTP::Get.new(uri)
+      req['Authorization'] = "Token token=\"#{ENV['GRAPHITI_TOKEN']}\""
+      res = http.request(req)
+      res.body
+    end
+  end
+end

data/lib/graphiti/configuration.rb

@@ -9,6 +9,9 @@ module Graphiti
     attr_accessor :concurrency
 
     attr_accessor :respond_to
+    attr_accessor :context_for_endpoint
+    attr_accessor :schema_path
+    attr_accessor :links_on_demand
 
     # Set defaults
     # @api private
@@ -16,6 +19,15 @@ module Graphiti
       @raise_on_missing_sideload = true
       @concurrency = false
       @respond_to = [:json, :jsonapi, :xml]
+      @links_on_demand = false
+
+      if defined?(::Rails)
+        @schema_path = "#{::Rails.root}/public/schema.json"
+      end
+    end
+
+    def schema_path
+      @schema_path ||= raise('No schema_path defined! Set Graphiti.config.schema_path to save your schema.')
     end
   end
 end

data/lib/graphiti/context.rb

@@ -10,6 +10,7 @@ module Graphiti
 
     included do
       class_attribute :sideload_whitelist
+      self.sideload_whitelist = {}
       class << self;prepend Overrides;end
     end
   end

data/lib/graphiti/errors.rb

@@ -16,6 +16,40 @@ The adapter #{@adapter.class} does not implement method '#{@method}', which was
       end
     end
 
+    class InvalidLink < Base
+      def initialize(resource_class, sideload)
+        @resource_class = resource_class
+        @sideload = sideload
+      end
+
+      def message
+        <<-MSG
+#{@resource_class.name}: Cannot link to sideload #{@sideload.name.inspect}!
+
+Make sure the endpoint "#{@sideload.resource.endpoint[:full_path]}" exists, or customize the endpoint for #{@sideload.resource.class.name}.
+
+If you do not wish to generate a link, pass link: false or set self.relationship_links_by_default = false.
+        MSG
+      end
+    end
+
+    class Unlinkable < Base
+      def initialize(resource_class, sideload)
+        @resource_class = resource_class
+        @sideload = sideload
+      end
+
+      def message
+        <<-MSG
+#{@resource_class.name}: Tried to link sideload #{@sideload.name.inspect}, but cannot generate links!
+
+Graphiti.config.context_for_endpoint must be set to enable link generation:
+
+Graphiti.config.context_for_endpoint = ->(path, action) { ... }
+        MSG
+      end
+    end
+
     class AttributeError < Base
       attr_reader :resource,
         :name,
@@ -75,6 +109,58 @@ The adapter #{@adapter.class} does not implement method '#{@method}', which was
       end
     end
 
+    class InvalidEndpoint < Base
+      def initialize(resource_class, path, action)
+        @resource_class = resource_class
+        @path = path
+        @action = action
+      end
+
+      def message
+        <<-MSG
+#{@resource_class.name} cannot be called directly from endpoint #{@path}##{@action}!
+
+Either set a primary endpoint for this resource:
+
+endpoint '/my/url', [:index, :show, :create]
+
+Or whitelist a secondary endpoint:
+
+secondary_endoint '/my_url', [:index, :update]
+
+The current endpoints allowed for this resource are: #{@resource_class.endpoints.inspect}
+        MSG
+      end
+    end
+
+    class InvalidType < Base
+      def initialize(key, value)
+        @key = key
+        @value = value
+      end
+
+      def message
+        "Type must be a Hash with keys #{Types::REQUIRED_KEYS.inspect}"
+      end
+    end
+
+    class ResourceEndpointConflict < Base
+      def initialize(path, action, resource_a, resource_b)
+        @path = path
+        @action = action
+        @resource_a = resource_a
+        @resource_b = resource_b
+      end
+
+      def message
+        <<-MSG
+Both '#{@resource_a}' and '#{@resource_b}' are associated to endpoint #{@path}##{@action}!
+
+Only one resource can be associated to a given url/verb combination.
+        MSG
+      end
+    end
+
     class PolymorphicChildNotFound < Base
       def initialize(resource_class, model)
         @resource_class = resource_class
@@ -209,15 +295,31 @@ end
       end
     end
 
+    class MissingSideloadFilter < Base
+      def initialize(resource_class, sideload, filter)
+        @resource_class = resource_class
+        @sideload = sideload
+        @filter = filter
+      end
+
+      def message
+        <<-MSG
+#{@resource_class.name}: sideload #{@sideload.name.inspect} is associated with resource #{@sideload.resource.class.name}, but it does not have corresponding filter.
+
+Expecting filter #{@filter.inspect} on #{@sideload.resource.class.name}.
+        MSG
+      end
+    end
+
     class ResourceNotFound < Base
-      def initialize(resource, sideload_name)
-        @resource = resource
+      def initialize(resource_class, sideload_name)
+        @resource_class = resource_class
         @sideload_name = sideload_name
       end
 
       def message
         <<-MSG
-Could not find resource class for sideload '#{@sideload_name}' on Resource '#{@resource.class.name}'!
+Could not find resource class for sideload '#{@sideload_name}' on Resource '#{@resource_class.name}'!
 
 If this follows a non-standard naming convention, use the :resource option to pass it directly: