ruby_graphiql_explorer 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2fe1194d4f2a7748ee3b98b5ed642046e321476474c9ddf098673525a1558c5
-  data.tar.gz: 0d3b574741f440de4413f57420dfb72d31da198ce2d52d881a00e8c1c2663a8b
+  metadata.gz: 3f7d2d0e2dd198f6264b5b8a9534f690cf4ee2caf66f6b3979c03396bc3ca06d
+  data.tar.gz: fe304a985c9aca320796bcb8ea23c465e6ff751e5d61e300e2abe8d41fd683c1
 SHA512:
-  metadata.gz: f828caa23d99a0e4cf38e91f84be16b91761a8a412db006ac062669f8ec2735d2c64d5ccfa7359e76de315b3291c6146b7d211b98c9d023bdf7acf64a1bfcd67
-  data.tar.gz: a2d014ba184e0bfdf0db9ff379f77798c128a17d0e45cb74f396fdda502f54a5752d1d649ce4ed50798a67b8f14fc04f71dbf93033495a83b63ee341556b4f29
+  metadata.gz: 394e7b6dae01f1d2b1fbabe8a70f1e36555661e81b5027b6b175106e7c7124385ba4c02fed4e3aa4ee4d69ecc88b5ac984e608a170cbca4d2515444ab209325a
+  data.tar.gz: 33b91a45ba38b298edcc854c3196881de34788b7ff86915eeec9643c4a439b8ff21d477816f5e4a1439ccf641b1c2df99a337fc3f4c1767ed6e6b7de65ffab3e

data/.github/workflows/ci.yml

@@ -1,30 +1,33 @@
-name: build
-
+name: Rspec
 on: [push, pull_request]
-
 jobs:
   build:
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v1
-
       - name: Install Ruby (2.6)
         uses: actions/setup-ruby@v1
         with:
           ruby-version: 2.6.x
-
+      - name: Cache Ruby gems
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
       - name: Setup Code Climate test-reporter
         run: |
           curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
           chmod +x ./cc-test-reporter
           ./cc-test-reporter before-build
-      - name: Build and test with RSpec
+      - name: Bundle and test with RSpec
         run: |
           gem install bundler
+          bundle config path vendor/bundle
           bundle install --jobs 4 --retry 3
           bundle exec rspec
       - name: Publish code coverage
         run: |
           export GIT_BRANCH="${GITHUB_REF/refs\/heads\//}"
-          ./cc-test-reporter after-build -r ${{secrets.CC_TEST_REPORTER_ID}}
+          ./cc-test-reporter after-build -r ${{secrets.CC_TEST_REPORTER_ID}} -t simplecov

data/Gemfile

@@ -6,4 +6,5 @@ gem "rake", "~> 12.0"
 
 group :test do
   gem "rspec"
+  gem "simplecov", ">= 0.17.1", "< 0.18", require: false
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_graphiql_explorer (1.0.0)
+    ruby_graphiql_explorer (1.0.1)
       rack-app
       rack-app-front_end
 
@@ -10,6 +10,8 @@ GEM
   specs:
     ast (2.4.1)
     diff-lcs (1.4.4)
+    docile (1.3.2)
+    json (2.3.1)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
@@ -50,6 +52,11 @@ GEM
     rubocop-performance (1.7.1)
       rubocop (>= 0.82.0)
     ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     tilt (2.0.10)
     unicode-display_width (1.7.0)
 
@@ -62,6 +69,7 @@ DEPENDENCIES
   rubocop
   rubocop-performance
   ruby_graphiql_explorer!
+  simplecov (>= 0.17.1, < 0.18)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,15 +1,19 @@
-# RubyGraphiqlExplorer
+[![Maintainability](https://api.codeclimate.com/v1/badges/2b689e2db08845bf3c28/maintainability)](https://codeclimate.com/github/gauravtiwari/ruby_graphiql_explorer/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/2b689e2db08845bf3c28/test_coverage)](https://codeclimate.com/github/gauravtiwari/ruby_graphiql_explorer/test_coverage)
+![Rspec](https://github.com/gauravtiwari/ruby_graphiql_explorer/workflows/Rspec/badge.svg)
 
-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/ruby_graphiql_explorer`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Ruby Graphiql Explorer
 
-TODO: Delete this and the text above, and describe your gem
+Super simple rack app to render GraphiQL editor into a Ruby or Rails web app.
+
+![Screenshot](https://user-images.githubusercontent.com/771039/92003081-7f6ca700-ed38-11ea-94af-48c2867d0c29.png)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ruby_graphiql_explorer'
+gem "ruby_graphiql_explorer"
 ```
 
 And then execute:
@@ -22,15 +26,46 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Rails
+
+Mount the rack app in `routes.rb`
+
+```rb
+mount RubyGraphiqlExplorer::App, at: "/graphiql"
+```
+
+### Ruby
+
+Using `config.ru`
+
+```rb
+require "ruby_graphiql_explorer"
+run RubyGraphiqlExplorer::App
+```
+
+Using `Rack::URLMap`
+
+```rb
+require "ruby_graphiql_explorer"
+run Rack::URLMap.new("/graphiql" => RubyGraphiqlExplorer::App)
+```
+
+By default the rack app expects GraphQL endpoint to be available at
+`http://localhost::3000/graphql` but you can override using
+`GRAPHQL_API_URL` env variable. Additionally, you can set api key/token using
+`GRAPHQL_API_KEY` if your GraphQL API is protected.
+
+```yml
+GRAPHQL_API_URL: http://localhost::3000/api
+GRAPHQL_API_KEY: foobar
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bundle` to install dependencies. Then, run `bundle exec rspec spec` to run the tests.
 
 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/[USERNAME]/ruby_graphiql_explorer.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/gauravtiwari/ruby_graphiql_explorer.

data/lib/ruby_graphiql_explorer/index.html.erb

@@ -25,10 +25,7 @@
           method: 'post',
           headers: {
             'Content-Type': 'application/json',
-            Authorization: '<%= ENV.fetch(
-              'GRAPHQL_API_KEY',
-              'http://localhost:3000/graphql'
-            ) %>'
+            Authorization: '<%= ENV.fetch('GRAPHQL_API_KEY', '') %>'
           },
           body: JSON.stringify(graphQLParams)
         })

data/lib/ruby_graphiql_explorer/version.rb

@@ -1,3 +1,3 @@
 module RubyGraphiqlExplorer
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_graphiql_explorer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Gaurav Tiwari
@@ -77,7 +77,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.6
-before_install: gem install bundler -v 2.1.4