graphtown 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c54e2275afc874fe0761dba661b16b746a9c3716f15eb74ee50d986ac442b04b
-  data.tar.gz: c113a90a48131d55dcf0b4d47ce1f17d6b383c5cbfd1fb765c5171a1ddb01499
+  metadata.gz: 7ab78a149acc477d7cf5dc2d10a37e6a9855b7b146465f1e18bd40d4ad5fe9f8
+  data.tar.gz: d36029de500ce26ad396e4ed0111d8203e84e9e04eae2595b8624feb0b728eb7
 SHA512:
-  metadata.gz: 16912ef133cdd7ae2ae3bfbef980839b6eb8e17a320eb8df113d6aef9bd3d3cbdab1e69bb73ecf4e20add8053a826a623b29cf955a51bab38de8352aa4620e3b
-  data.tar.gz: a66847460dbd420e44a20f2f4ed98040d4ea72b8b22a86179eb94eff25169f86d0d46463281ee9a22d2730269b48fce64d0d18cf364765636eaff92bfc6c3695
+  metadata.gz: 2584c1981f3de679c846164c12df1b9fe82b14c639ed308a01c022b85e9bb33acd8e80374ea7fdd2b619e37d6f122d5a158c94d08b3f8ff24e1550f98d3a2b55
+  data.tar.gz: fdb4af743a3cb3eaad5bf71cbbf67cdfc43db1b47e3b33bb554b8095515fb62339f5cd85bd74d6bd58745fcf5833de877c05f606b875eddebe90a7da6ba8fe77

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: jaredcwhite

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # main
 
+# 1.1.0 / 2021-04-06
+
+* Add support for string-based queries in addition to Ruby DSL [[#2](https://github.com/whitefusionhq/graphtown/pull/2)] ([pusewicz](https://github.com/pusewicz))
+
 # 1.0.1 / 2020-08-20
 
 * Add better detection of matching/not-matching data roots

data/README.md

@@ -1,6 +1,6 @@
 # Graphtown
 
-Easily consume GraphQL APIs for your Bridgetown website using a tidy Builder DSL on top of the [Graphlient](http://github.com/ashkan18/graphlient) gem.
+Easily consume GraphQL APIs for your [Bridgetown](https://www.bridgetownrb.com) website using a tidy Builder DSL on top of the [Graphlient](http://github.com/ashkan18/graphlient) gem.
 
 ## Installation
 
@@ -36,19 +36,102 @@ def graphql_endpoint
 end
 ```
 
----
+## Usage
 
-# Documentation coming soon…
+You'll start by creating a builder plugin which defines a GraphQL query using the DSL provided by the Graphlient gem. Then, in the `build` method of the plugin, you can execute the query and use that data to add content to your site.
 
-## Usage
+Here's an example of using the GraphQL API provided by [Strapi](https://strapi.io) (a headless CMS) to turn blog posts authored in the CMS into Bridgetown posts:
+
+```ruby
+# plugins/builders/strapi_posts.rb
+
+class StrapiPosts < SiteBuilder
+  graphql :posts do
+    query {
+      posts {
+        id
+        title
+        description
+        body
+        createdAt
+      }
+    }
+  end
+
+  def build
+    queries.posts.each do |post|
+      slug = Bridgetown::Utils.slugify(post.title)
+      doc "#{slug}.md" do
+        layout "post"
+        date post.created_at
+        front_matter post.to_h
+        content post.body
+      end
+    end
+  end
+end
+```
 
-The plugin will…
+The `queries` object will contain the same graph names as what you define using the `graphql` class method. If the "data root" of the query is the same as the graph name, you don't have to access the root specifically. In other words, you don't have to write `queries.posts.posts.each do |post|`. However, if your data root is different, you'll need to access it specifically (see below where it's written as `queries.github.viewer…`).
 
-### Optional configuration options
+Here's an example of using an authenticated GitHub API to access a list of repositories owned by the user associated with the API key. It includes configuring the Graphlient client to provide the API key in the request header, as well as utilizing query variables which get resolved at runtime.
 
-The plugin will automatically use any of the following metadata variables if they are present in your site's `_data/site_metadata.yml` file.
+```ruby
+# plugins/builders/github_graphql.rb
+
+class GitHubGraphql < SiteBuilder
+  graphql :github do
+    query(number_of_repos: :int) do
+      viewer do
+        repositories(first: :number_of_repos) do
+          edges do
+            node do
+              name
+              description
+              createdAt
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def variables_for_github
+    {
+      # pull this out of the bridgetown.config.yaml, if present:
+      number_of_repos: config[:github_repo_limit] || 10
+    }
+  end
+
+  def build
+    queries.github.viewer.repositories.edges.each do |item|
+      repo = item.node
+      slug = Bridgetown::Utils.slugify(repo.name)
+
+      doc "#{slug}.md" do
+        layout "repository"
+        date repo.created_at
+        title repo.name
+        content repo.description
+      end
+    end
+  end
+
+  def graphql_endpoint
+    "https://api.github.com/graphql"
+  end
+
+  def configure_graphql_client(client)
+    client.options[:headers] = {
+      "Authorization" => "bearer #{ENV["GITHUB_API_TOKEN"]}"
+    }
+  end
+end
+```
 
-…
+Note that these examples show just one GraphQL query defined in the plugin, but you can call the `graphql` class method multiple times with different graph names/queries, and access any or all of them in the `build` method.
+
+If you run into any issues or need further assistance using GraphQL in your Bridgetown project, [please reach out to the Bridgetown community](https://www.bridgetownrb.com/docs/community) via chat or other means. If you think you've encountered a bug, please file an issue here in the GitHub repo. 
 
 ## Testing
 
@@ -62,4 +145,9 @@ The plugin will automatically use any of the following metadata variables if the
 3. Create your feature branch (`git checkout -b my-new-feature`)
 4. Commit your changes (`git commit -am 'Add some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
-6. Create a new Pull Request
+6. Create a new Pull Request
+
+## Releasing
+
+To release a new version of the plugin, simply bump up the version number in
+`version.rb` and then run `script/release`.

data/lib/graphtown/query_builder.rb

@@ -12,9 +12,9 @@ module Graphtown
     class_methods do
       attr_accessor :graphql_queries
 
-      def graphql(graph_name, &block)
+      def graphql(graph_name, query = nil, &block)
         self.graphql_queries ||= Queries.new
-        graphql_queries.send("#{graph_name}=", block)
+        graphql_queries.send("#{graph_name}=", query || block)
       end
     end
 
@@ -22,16 +22,15 @@ module Graphtown
       return self.class.graphql_queries if @_executed_queries
 
       client = graphql_client
-      self.class.graphql_queries.each_pair do |graph_name, block|
-        graph_dsl = Graphlient::Query.new(&block)
-
+      self.class.graphql_queries.each_pair do |graph_name, value|
+        query = parse_graphql_query(client, value)
         query_variables = if respond_to?("variables_for_#{graph_name}")
                             send("variables_for_#{graph_name}")
                           end
 
         self.class.graphql_queries.send(
           "#{graph_name}=",
-          client.execute(graph_dsl.to_s, query_variables).data.yield_self do |data|
+          client.execute(query, query_variables).data.yield_self do |data|
             # avoid having to do query.foo.foo if possible
             data.send(graph_name)
           rescue NoMethodError
@@ -44,6 +43,10 @@ module Graphtown
       self.class.graphql_queries
     end
 
+    def parse_graphql_query(client, value)
+      value.is_a?(Proc) ? Graphlient::Query.new(&value).to_s : client.parse(value)
+    end
+
     def graphql_client
       Graphlient::Client.new(graphql_endpoint) do |client|
         configure_graphql_client(client)

data/lib/graphtown/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Graphtown
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphtown
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Jared White
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2021-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -134,6 +134,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -165,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Easily consume GraphQL APIs for your Bridgetown website using a tidy Builder