graphqr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0fb5f222bd481b018d41ea5033bfa5402c5bbec
+  data.tar.gz: 4ba76746f0322bba9067fef162459c54dfa5340e
+SHA512:
+  metadata.gz: 518e94ce07c32774355fb55d1ca6a3b42c685685e942e6ca657eea13dec850c5c763f19c213cf75b4a976f97667fbdc0099c1406bd08ff880f3acc1616d77a30
+  data.tar.gz: 3693a00b845f41176bc1606461f72dbc09236fec9361759b6f5092b08a2ac2eec0af5cb818192b52f6c37b66969b34f6d78189d11e1c1b6522c36c8d22219b49

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Manuel Puyol
+
+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,43 @@
+# GraphQR
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/graphqr`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphqr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphqr
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/QultureRocks/graphqr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GraphQR project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/QultureRocks/graphqr/blob/master/CODE_OF_CONDUCT.md).

data/lib/graphqr/apply_scopes.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module GraphQR
+  ##
+  # The ApplyScopes module defines a way of applying model scopes in the GraphQL universe
+  # it is based on the [has_scope](https://github.com/plataformatec/has_scope/) gem, but simplified for more basic usage
+  module ApplyScopes
+    ##
+    # This method is a parallel to the one offerend by the `has_scope` gem.
+    # A big difference in this case is the necessity of the second parameter (normally it only takes one).
+    #
+    # ### Params:
+    #
+    # +target+: the ActiveRecordRelation that will be filtered using scopes
+    #
+    # +scopes+: a hash of scopes and their values, those only accept Array, String, Integer or Boolean types.
+    # **Hash scopes are not yet supported**
+    #
+    # ### Example:
+    #
+    # ```
+    # apply_scopes(User, { with_id: [1,2,3], order_by_name: true} )
+    # ```
+    def apply_scopes(target, scopes)
+      parsed_scopes = parse_scopes(scopes.to_h)
+
+      parsed_scopes.each do |scope, value|
+        target = call_scope(target, scope, value)
+      end
+
+      target
+    end
+
+    private
+
+    ##
+    # Parses the scope hash, removing scopes with a `nil` or `false` value
+    def parse_scopes(scopes)
+      scopes.inject({}) do |acc, option|
+        option.last.present? ? acc.merge(option.first => option.last) : acc
+      end
+    end
+
+    ##
+    # Calls the scope with the correct parametes (none if its a boolean type)
+    def call_scope(target, scope, value)
+      if boolean?(value)
+        target.send(scope)
+      else
+        target.send(scope, value)
+      end
+    end
+
+    ##
+    # Checks whether the value is a Boolean checking its class
+    def boolean?(value)
+      value.class == TrueClass || value.class == FalseClass
+    end
+  end
+end

data/lib/graphqr/authorized.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module GraphQR
+  ##
+  # TODO: add documentation
+  module Authorized
+    def authorized?(object, context)
+      policy_provider = context[:policy_provider]
+
+      super && policy_provider.allowed?(action: :show?, record: object)
+    end
+  end
+end

data/lib/graphqr/base.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module GraphQR
+  ##
+  # The Base module defines some helper methods that can be used once it is included
+  # it also includes the basic ApplyScopes library
+  module Base
+    include GraphQR::ApplyScopes
+
+    DEFAULT_AUTHORIZATION_ERROR = 'You are not authorized to perform this action'
+
+    ##
+    # This method is a wrapper around the Pundit authorize, receiving the same arguments.
+    # The only difference is that it turns the Pundit::NotAuthorizedError into a GraphQL::ExecutionError
+    #
+    # ### Example:
+    #
+    # ```
+    # authorize_graphql User, :index?
+    # ```
+    def authorize_graphql(record, action, policy_class: nil)
+      args = { record: record, action: action, policy_class: policy_class }
+      raise GraphQL::ExecutionError, DEFAULT_AUTHORIZATION_ERROR unless policy_provider.allowed?(args)
+    end
+
+    ##
+    # This is a helper method to get the policy provider from the context
+    def policy_provider
+      context[:policy_provider]
+    end
+  end
+end

data/lib/graphqr/fields/base_field.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GraphQR
+  ##
+  # This module represents all the extensions we made to the basic GraphQL::Schema::Field class
+  # it contains helpers and integrations we need to keep our workflow as simple as possible.
+  module Fields
+    ##
+    # The BaseField class rewrites the field initialization, adding some options that could be helpful:
+    #
+    # ## paginate
+    # This option defines if the field should use the PaginationExtension
+    #
+    # ### Example:
+    # ```
+    # field :users, [UserType], paginate: true
+    # ```
+    class BaseField < GraphQL::Schema::Field
+      def initialize(*args, paginate: false, **kwargs, &block)
+        super(*args, **kwargs, &block)
+        extension(Pagination::PaginationExtension) if paginate
+        extension(PermittedFieldsExtension, null: kwargs[:null])
+      end
+    end
+  end
+end

data/lib/graphqr/pagination/pagination_extension.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GraphQR
+  module Pagination
+    ##
+    # TODO: add documentation
+    class PaginationExtension < GraphQL::Schema::FieldExtension
+      def apply
+        field.argument :per, 'Int', required: false, default_value: 25,
+                                    description: 'The requested number of nodes for the page'
+        field.argument :page, 'Int', required: false, default_value: 1,
+                                     description: 'The requested page number'
+      end
+
+      # Remove pagination args before passing it to a user method
+      def resolve(object:, arguments:, **_kwargs)
+        next_args = arguments.dup
+        next_args.delete(:per)
+        next_args.delete(:page)
+        yield(object, next_args)
+      end
+
+      def after_resolve(value:, arguments:, **_kwargs)
+        PaginationResolver.new(value, items: arguments[:per], page: arguments[:page])
+      end
+    end
+  end
+end

data/lib/graphqr/pagination/pagination_resolver.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module GraphQR
+  module Pagination
+    ##
+    # TODO: add documentation
+    class PaginationResolver
+      include Pagy::Backend
+
+      def initialize(records, arguments)
+        @records = records
+        @arguments = arguments
+
+        @pagy, paginated_records = pagy(records, arguments)
+        @paginated_records = paginated_records.to_a
+      end
+
+      def cursor_from_node(item)
+        item.to_global_id.to_s
+      end
+
+      def edge_nodes
+        @paginated_records
+      end
+
+      def nodes
+        @paginated_records
+      end
+
+      def edges
+        @paginated_records
+      end
+
+      def page_info
+        @pagy
+      end
+    end
+  end
+end

data/lib/graphqr/pagination/types/pagination_page_info_type.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GraphQR
+  module Pagination
+    module Types
+      ##
+      # TODO: add documentation
+      class PaginationPageInfoType < GraphQL::Schema::Object
+        description 'Information about pagination in a connection.'
+
+        field :total_count, Int, null: false,
+                                 method: :count,
+                                 description: 'The collection count'
+        field :page, Int, null: false,
+                          description: 'The current page number'
+        field :nodes_count, Int, null: false,
+                                 method: :items,
+                                 description: 'The actual number of nodes in the current non-empty page'
+        field :pages_count, Int, null: false,
+                                 method: :pages,
+                                 description: 'The number of total pages in the collection'
+        field :previous_page, Int, null: true,
+                                   method: :prev,
+                                   description: 'The previous page number or nil if there is no previous page'
+        field :next_page, Int, null: true,
+                               method: :next,
+                               description: 'The previous page number or nil if there is no previous page'
+      end
+    end
+  end
+end

data/lib/graphqr/pagination.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GraphQR
+  ##
+  # TODO: add documentation
+  module Pagination
+    def pagination_type
+      @pagination_type ||= begin
+        conn_name = "#{graphql_name}Pagination"
+        edge_type_class = edge_type
+
+        Class.new(connection_type_class) do
+          graphql_name(conn_name)
+          edge_type(edge_type_class)
+
+          field :page_info, Pagination::Types::PaginationPageInfoType, null: false,
+                                                                       description: 'Information to aid in pagination.'
+        end
+      end
+    end
+  end
+end

data/lib/graphqr/permitted_fields_extension.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module GraphQR
+  ##
+  # TODO: add documentation
+  class PermittedFieldsExtension < GraphQL::Schema::FieldExtension
+    def resolve(object:, arguments:, context:)
+      if authorized?(object, context)
+        yield(object, arguments, nil)
+      else
+        on_unauthorized
+      end
+    end
+
+    private
+
+    def on_unauthorized
+      raise GraphQL::ExecutionError, 'You are not authorized to perform this action' if field_required?
+    end
+
+    def field_required?
+      !options[:null]
+    end
+
+    def authorized?(object, context)
+      if root_type?(object, context)
+        true
+      else
+        context[:policy_provider].permitted_field?(record: object.object, field_name: field_name)
+      end
+    end
+
+    def field_name
+      field.original_name
+    end
+
+    def root_type?(object, context)
+      root_types = [context.schema.query.graphql_name, context.schema.mutation.graphql_name]
+
+      root_types.include? object.class.graphql_name
+    end
+  end
+end

data/lib/graphqr/query_field.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/ParameterLists
+
+module GraphQR
+  ##
+  # TODO: add documentation
+  module QueryField
+    def query_field(field_name, active_record_class, type_class:, scope_class: nil, **kwargs, &block)
+      is_collection = active_record_class.is_a? Array
+      if is_collection
+        active_record_class = active_record_class.first
+        resolver = collection(active_record_class, type_class, scope_class)
+      else
+        resolver = resource(active_record_class, type_class)
+      end
+
+      field(field_name, paginate: is_collection, resolver: resolver, **kwargs, &block)
+    end
+
+    private
+
+    def collection(active_record_class, type_class, scope_class)
+      Class.new(::BaseResolver) do
+        class_attribute :active_record_class
+        self.active_record_class = active_record_class
+
+        type type_class.pagination_type, null: false
+
+        argument :filter, scope_class, required: false
+
+        def resolve(filter: {})
+          authorize_graphql active_record_class, :index?
+
+          collection = apply_scopes(active_record_class, filter)
+          context[:policy_provider].authorized_records(records: collection)
+        end
+      end
+    end
+
+    def resource(active_record_class, type_class)
+      Class.new(::BaseResolver) do
+        class_attribute :active_record_class
+        self.active_record_class = active_record_class
+
+        type type_class, null: false
+
+        argument :id, 'ID', required: true
+
+        def resolve(id:)
+          record = self.class.active_record_class.find(id)
+
+          context[:policy_provider].allowed?(action: :show?, record: record)
+
+          record
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ParameterLists

data/lib/graphqr/scope_items.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GraphQR
+  ##
+  # TODO: add documentation
+  module ScopeItems
+    def scope_items(items, context)
+      if scopable_items?(items)
+        context[:policy_provider].authorized_records(records: items)
+      else
+        items
+      end
+    end
+
+    private
+
+    def scopable_items?(items)
+      items.is_a? ActiveRecord::Relation
+    end
+  end
+end

data/lib/graphqr/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GraphQR
+  VERSION = '0.0.1'
+end

data/lib/graphqr.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'graphql'
+require 'pagy'
+
+##
+# This module represents all the extensions we made to the graphql-ruby library
+# it contains helpers and integrations we need to keep our workflow as simple as possible.
+module GraphQR
+  class << self
+    # Switches GraphQR on or off
+    def enabled=(value)
+      GraphQR.config.enabled = value
+    end
+
+    # Returns if GraphQR is turned on
+    def enabled?
+      GraphQR.config.enabled.present?
+    end
+  end
+end
+
+require 'graphqr/fields/base_field'
+
+require 'graphqr/pagination/types/pagination_page_info_type'
+require 'graphqr/pagination/pagination_extension'
+require 'graphqr/pagination/pagination_resolver'
+
+require 'graphqr/apply_scopes'
+require 'graphqr/authorized'
+require 'graphqr/base'
+require 'graphqr/pagination'
+require 'graphqr/permitted_fields_extension'
+require 'graphqr/query_field'
+require 'graphqr/scope_items'
+require 'graphqr/version'

data/spec/graphqr_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe GraphQR do
+  it 'has a version number' do
+    expect(GraphQR::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'graphqr'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: graphqr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Manuel Puyol
+- Eric La Rosa
+- João Batista Marinho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extensions and helpers for graphql-ruby
+email:
+- manuelpuyol@gmail.com
+- eric@rosa.la
+- joao@qulture.rocks
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/graphqr.rb
+- lib/graphqr/apply_scopes.rb
+- lib/graphqr/authorized.rb
+- lib/graphqr/base.rb
+- lib/graphqr/fields/base_field.rb
+- lib/graphqr/pagination.rb
+- lib/graphqr/pagination/pagination_extension.rb
+- lib/graphqr/pagination/pagination_resolver.rb
+- lib/graphqr/pagination/types/pagination_page_info_type.rb
+- lib/graphqr/permitted_fields_extension.rb
+- lib/graphqr/query_field.rb
+- lib/graphqr/scope_items.rb
+- lib/graphqr/version.rb
+- spec/graphqr_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/QultureRocks/graphqr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Extensions and helpers for graphql-ruby
+test_files:
+- spec/spec_helper.rb
+- spec/graphqr_spec.rb