github-graphql 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b787724c4b0aca62917c14ccc07a76cda920e449
-  data.tar.gz: 5e39ec8434559bdcc2994fccfc39bae45ab6b999
+  metadata.gz: 9e629e8d8167946aa97d0bae290b2e13368f82bc
+  data.tar.gz: e39d3eee7f3b1c920da89070e16083d528537c8c
 SHA512:
-  metadata.gz: 87926f25f026f87a35a5bb210e3a4b32c83367f69effb38bff62ec77405ab12909ab1cc3cb9b972683e2a3f4dbc068cfa75e7c7b01924317c990505de37ad36f
-  data.tar.gz: cde8169468bc8f054cbd5f7dbeb60f980cb14827a16063ba59303ca3e05388e3d08c99a18ac611b12f7466e1d2bad2582a34ac34cf0a4f2a0291ff258f34a998
+  metadata.gz: f7747e6b7be1dc312d0d849d1b765de98fe5f81d78bcf8fec572c09480455bb261ccf050932348715bac0f0d3bea125ba20ec847ed468f66d8344c7575ddedbb
+  data.tar.gz: 41ba79ce2c8074d66586d008af5dd4ef44764c3c427fd41c1d3d1ee40e9df9b89e47afc071917b65b6bdd1852f621755cd17d888494bf4673dfe515b2d01fbbe

data/lib/github/graphql.rb

@@ -1,11 +1,22 @@
-# Github Utilities Module
+##
+# This module contains tools for interacting with the Github API
+#
 module Github
   require 'net/http'
   require 'uri'
   require 'json'
 
-  # Used to Query the Github GraphQL API
+  ##
+  # This class is used to make queries to the Github GraphQL API
+  #
   class GraphQL
+    ##
+    # Expects a valid Github OAuth token & the GraphQL query string,
+    # and optionally a hash array of any variables to be passed with
+    # the query.
+    #
+    # With raise an ArgumentError if either token or query are nil.
+    #
     def initialize(token, query, vars = nil)
       @payload = {}
 
@@ -20,11 +31,22 @@ module Github
       payload(query, vars)
     end
 
+    ##
+    # Set the OAuth token.
+    #
+    # Will raise an ArgumentError if token is nil
+    #
     def token(token)
       raise ArgumentError, 'Cannot have nil token!', caller if token.nil?
       @request['Authorization'] = "bearer #{token}"
     end
 
+    ##
+    # Set the query string and optionally the variables to be passed
+    # with the query.
+    #
+    # Will raise an ArgumentError if query is nil
+    #
     def payload(query, vars = nil)
       raise ArgumentError, 'Cannot have nil query!', caller if query.nil?
       @payload['query'] = query
@@ -32,12 +54,24 @@ module Github
       @request.body = @payload.to_json
     end
 
+    ##
+    # Execute the query.
+    #
+    # Returns a ruby hash array of the response from Github.
+    #
     def query
       response = @http.request(@request)
       JSON.parse(response.body)
     end
   end
 
+  ##
+  # Execute a query to the GraphQL API. Expects a valid Github OAuth
+  # token and the query string, and optionally a hash array of the
+  # variables to be passed with the query.
+  #
+  # Will raise an ArgumentException if either token or query are nil.
+  #
   def self.query(token, query, vars = nil)
     GraphQL.new(token, query, vars).query
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-graphql
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Caleb Smith
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement