solidus_graphql_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e13d165667b997910b872578daab0555697266f687273c44591815ad4e25fb54
+  data.tar.gz: 83e8894cdd383331705701f8e69aa97aefeded8d42d07c4cc88f29fcd03b0ac1
+SHA512:
+  metadata.gz: e83c25b7120e61b3d5c7e20773159c87b66fc01f2439d4d829c6d19b3abf143f21af16581b75fe6e6561540963aca1a00493dcbf598d5145c128e384bae639eb
+  data.tar.gz: 43e1ce11f2e47eb48d4d9b7157a69f1c15a9a0d67871cde22bfeb93b72f84205ecb721b7484ea27ea85a3f2a02c099f15693f85ac65ba0c5e51afb6d3b5b68dd

data/.circleci/config.yml

@@ -0,0 +1,93 @@
+version: 2.1
+
+orbs:
+  # Always take the latest version of the orb, this allows us to
+  # run specs against Solidus supported versions only without the need
+  # to change this configuration every time a Solidus version is released
+  # or goes EOL.
+  solidusio_extensions: solidusio/extensions@volatile
+
+commands:
+  bundle:
+    description: 'Install and cache gems'
+    steps:
+      - restore_cache:
+          keys:
+            - v1-bundle-{{ checksum "solidus_graphql_api.gemspec" }}-{{ checksum "Gemfile" }}
+            - v1-bundle-{{ checksum "solidus_graphql_api.gemspec" }}
+            - v1-bundle-
+      - run: bundle check || bundle install
+      - save_cache:
+          key: v1-bundle-{{ checksum "solidus_graphql_api.gemspec" }}-{{ checksum "Gemfile" }}
+          paths:
+            - ~/project/vendor/bundle
+
+jobs:
+  verify-schema-updated:
+    docker:
+      - image: circleci/ruby:2.5.6-node
+        environment:
+          BUNDLE_PATH: vendor/bundle
+    steps:
+      - checkout
+      - bundle
+      - run:
+          name: Check if Schema is up-to-date
+          command: |
+            mv schema.graphql old_schema.graphql
+            bundle exec rake schema:idl
+            diff old_schema.graphql schema.graphql
+
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - solidusio_extensions/run-tests
+      - run:
+          name: Install & Upload test coverage to Code Climate
+          command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+            ./cc-test-reporter format-coverage -t simplecov -o ./coverage/codeclimate.json
+            ./cc-test-reporter upload-coverage
+
+  run-specs-with-mysql:
+    executor: solidusio_extensions/mysql
+    steps:
+      - solidusio_extensions/run-tests
+
+  schema-breaking-change-detection:
+    docker:
+      - image: circleci/ruby:2.5.6-node
+    steps:
+      - checkout
+      - run:
+          name: Install GraphQL::SchemaComparator
+          command: gem install graphql-schema_comparator
+      - run:
+          name: Schema Breaking Change detection
+          command: rm Gemfile && schema_comparator verify "`git show origin/master:schema.graphql`" schema.graphql
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - verify-schema-updated
+      - schema-breaking-change-detection:
+          requires:
+            - verify-schema-updated
+      - run-specs-with-postgres:
+          requires:
+            - verify-schema-updated
+      - run-specs-with-mysql:
+          requires:
+            - verify-schema-updated
+  "Weekly run specs against master":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql

data/.gem_release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/solidus_graphql_api/version.rb'
+  message: Bump SolidusGraphqlApi to %{version}
+  tag: true

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+spec/examples.txt
+/sandbox
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,62 @@
+require:
+  - solidus_dev_support/rubocop
+
+Style/ExpandPathArguments:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Performance/RegexpMatch:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/NotToNot:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/LeadingSubject:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/PredicateMatcher:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/LeakyConstantDeclaration:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/HookArgument:
+  Enabled: false
+
+Layout/AlignArguments:
+  Enabled: false
+
+Rails/RakeEnvironment:
+  Enabled: false
+
+Rails/HttpStatus:
+  Enabled: false

data/CONTRIBUTING.md

@@ -0,0 +1,57 @@
+# How to contribute
+
+Third-party patches are essential to any great open source project. We want
+to keep it as easy as possible to contribute changes that get things working
+in your environment. There are a few guidelines that we need contributors to
+follow so that we can have a chance of keeping on top of things.
+
+## Getting Started
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a ticket for your issue, assuming one does not already exist.
+  * Clearly describe the issue including steps to reproduce when it is a bug.
+  * Make sure you fill in the earliest version that you know has the issue.
+* Fork the repository on GitHub
+
+## Making Changes
+
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * Only target release branches if you are certain your fix must be on that
+    branch.
+  * To quickly create a topic branch based on master; `git branch
+    fix/master/my_contribution master` then checkout the new branch with `git
+    checkout fix/master/my_contribution`.  Please avoid working directly on the
+    `master` branch.
+* Make commits of logical units.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are in the proper format.
+
+````
+    (#99999) Make the example in CONTRIBUTING imperative and concrete
+
+    Without this patch applied the example commit message in the CONTRIBUTING
+    document is not a concrete example.  This is a problem because the
+    contributor is left to imagine what the commit message should look like
+    based on a description rather than an example.  This patch fixes the
+    problem by making the example concrete and imperative.
+
+    The first line is a real life imperative statement with a ticket number
+    from our issue tracker.  The body describes the behavior without the patch,
+    why this is a problem, and how the patch fixes the problem when applied.
+````
+
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+## Submitting Changes
+
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the extensions repository.
+* Update any Github issues to mark that you have submitted code and are ready for it to be reviewed.
+  * Include a link to the pull request in the ticket
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/Gemfile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+gem 'solidus', github: 'solidusio/solidus', branch: branch
+
+# Needed to help Bundler figure out how to resolve dependencies,
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem 'rails', '>0.a'
+
+# Provides basic authentication functionality for testing parts of your engine
+gem 'solidus_auth_devise'
+
+case ENV['DB']
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
+else
+  gem 'sqlite3'
+end
+
+gemspec
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g. pry-byebug.
+#
+# We use `send` instead of calling `eval_gemfile` to work around an issue with
+# how Dependabot parses projects: https://github.com/dependabot/dependabot-core/issues/1658.
+send(:eval_gemfile, 'Gemfile-local') if File.exist? 'Gemfile-local'

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2020 Nebulab
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Solidus nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2019 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Solidus nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,245 @@
+[![Maintainability](https://api.codeclimate.com/v1/badges/8ea7739ad6726ad8cfa7/maintainability)](https://codeclimate.com/github/solidusio-contrib/solidus_graphql_api/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/8ea7739ad6726ad8cfa7/test_coverage)](https://codeclimate.com/github/solidusio-contrib/solidus_graphql_api/test_coverage)
+[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_graphql_api.svg?style=svg)](https://circleci.com/gh/solidusio-contrib/solidus_graphql_api)
+
+# SolidusGraphqlApi
+
+Provides a [graphql](https://graphql.org/) api for the [Solidus](https://github.com/solidusio/solidus) ecommerce framework.
+
+## Installation
+
+Add solidus_graphql_api to your Gemfile:
+
+```ruby
+gem 'solidus_graphql_api'
+```
+
+Bundle your dependencies:
+
+```shell
+bundle
+```
+
+Unlike the REST API which has a variety of endpoints, the GraphQL API has a
+single endpoint accessible under `/graphql`.
+
+For example in development you can use:
+
+```
+POST http://localhost:3000/graphql
+```
+
+## Customizations
+
+You can extend the gem functionality through decorators, just like Solidus.
+
+For example, assuming we are placing our grapqhl decorators in `app/graphql/types`:
+
+### Adding a new field
+
+```ruby
+module Graphql
+  module Types
+    module ProductDecorator
+      def self.prepended(base)
+        base.field :test, GraphQL::Types::String, null: true
+      end
+
+      def test
+        'test'
+      end
+
+      SolidusGraphqlApi::Types::Product.prepend self
+    end
+  end
+end
+```
+
+or also, if we want to add the taxon relation to the type product:
+
+```ruby
+module Graphql
+  module Types
+    module ProductDecorator
+      def self.prepended(base)
+        base.field :taxons, SolidusGraphqlApi::Types::Taxon.connection_type, null: true
+      end
+
+      def taxons
+        SolidusGraphqlApi::BatchLoader.for(object, :taxons)
+      end
+
+      SolidusGraphqlApi::Types::Product.prepend self
+    end
+  end
+end
+```
+
+### Modifying an existing field
+
+Like for adding a new field, we modify the `name` field in the same way:
+
+```ruby
+module Graphql
+  module Types
+    module ProductDecorator
+      def self.prepended(base)
+        base.field :name, GraphQL::Types::String, null: true
+      end
+
+      def name
+        object.concat(' ', 'Graphql')
+      end
+
+      SolidusGraphqlApi::Types::Product.prepend self
+    end
+  end
+end
+```
+
+### Removing a field
+
+```ruby
+module Graphql
+  module Types
+    module ProductDecorator
+      def self.prepended(base)
+        base.remove_field :name
+      end
+
+      SolidusGraphqlApi::Types::Product.prepend self
+    end
+  end
+end
+```
+
+### Adding a new Type
+
+Let's say we want the Product type to return its stock_items:
+
+First we create a StockItem type:
+
+```ruby
+module Graphql
+  module Types
+    class StockItem < SolidusGraphqlApi::Types::Base::RelayNode
+      description 'StockItem.'
+
+      field :count_on_hand, Integer, null: false
+    end
+  end
+end
+```
+
+And in the product decorator type:
+
+```ruby
+require_relative 'stock_item'
+
+module Graphql
+  module Types
+    module ProductDecorator
+      def self.prepended(base)
+        base.field :stock_items, Graphql::Types::StockItem.connection_type, null: false
+      end
+
+      def stock_items
+        object.stock_items
+      end
+
+      SolidusGraphqlApi::Types::Product.prepend self
+    end
+  end
+end
+```
+
+The query may look something like:
+
+```ruby
+query productBySlug ($slug: String!) {
+  productBySlug (slug: $slug) {
+    stockItems {
+      nodes {
+        countOnHand
+      }
+    }
+  }
+}
+```
+
+### Adding a new Query
+
+```ruby
+module Graphql
+  module Types
+    module QueryDecorator
+      def self.prepended(base)
+        base.field :taxons, SolidusGraphqlApi::Types::Taxon.connection_type, null: false
+      end
+
+      def taxons
+        Spree::Taxon.all
+      end
+
+      SolidusGraphqlApi::Types::Query.prepend self
+    end
+  end
+end
+```
+
+In your application you probably want to create a query object to retrieves the taxons.
+Check `SolidusGraphqlApi::Types::Query` for examples.
+
+## Development
+
+### Testing the extension
+
+First bundle your dependencies, then run `bin/rake`. `bin/rake` will default to building the dummy
+app if it does not exist, then it will run specs. The dummy app can be regenerated by using
+`bin/rake extension:test_app`.
+
+```shell
+bundle
+bin/rake
+```
+
+To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
+
+```shell
+bundle exec rubocop
+```
+
+When testing your application's integration with this extension you may use its factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'solidus_graphql_api/factories'
+```
+
+## Running the sandbox
+
+To run this extension in a sandboxed Solidus application, you can run `bin/sandbox`. The path for
+the sandbox app is `./sandbox` and `bin/rails` will forward any Rails commands to
+`sandbox/bin/rails`.
+
+Here's an example:
+
+```shell
+$ bin/rails server
+=> Booting Puma
+=> Rails 6.0.2.1 application starting in development
+* Listening on tcp://127.0.0.1:3000
+Use Ctrl-C to stop
+```
+
+### Releasing new versions
+
+Your new extension version can be released using `gem-release` like this:
+
+```shell
+bundle exec gem bump -v VERSION --tag --push --remote upstream && gem release
+```
+
+## License
+
+Copyright (c) 2020 Nebulab, released under the New BSD License.