okay 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c80a7352326cc10efc3054833ae3d3fd81151d16a1dee650b605c8657387710
-  data.tar.gz: 9606264cc4d9ef40d7e7a1807ea0c73bf08716d26285edc203e98cc231d4b5e5
+  metadata.gz: 5954167c96379ab1ee2a94068253b417f17bdea70a4d9b700b8e94e8e59c5495
+  data.tar.gz: fad91f6ef89734072991b0985763b98a0c6195d7b0176d76ee3d401dbca645ae
 SHA512:
-  metadata.gz: 7a199e77c5a83901da60cd19e4d7938d3e599af3f2e16157a626c2954f6ad5fee49b7804473cf5c918c0380c87e1af08c74201e112a30108c6bad4e5f5d79a74
-  data.tar.gz: c00aa59fdefcf05ca3227a38ad557e82ed0f7a810db9cf0019580b3bedca10fb6d6e61fa3295e75923817571861b17bef77a68369610c9332f2eda45c9608260
+  metadata.gz: 96337777a6f774ff282af8f883b11411977b14ee43e277d1fb239dfe85a2ce805451ffcfdcc6f65608d7e3ac552bf82bdbce6138ed0bd88278901513f6ddb805
+  data.tar.gz: a4cb525e1ab90e43d56a40e52641ef5143cc0a8e14554f47398b8b9d1bc39c80d4218683b38ef699cb13daed58835be83b64d7bebc68ab3213c56fe89bb63c2f

data/README.md

@@ -65,6 +65,26 @@ Okay::HTTP.post("https://httpbin.org/post", form_data: { "foo" => "bar" })
 Okay::HTTP.post("https://httpbin.org/post", data: "hello, world!")
 ```
 
+### GraphQL
+
+```ruby
+require "okay/graphql"
+require "json"
+
+query = GraphQL.query {
+    viewer {
+        login
+    }
+}
+
+response = request.submit!(:github, {bearer_token: ENV["DEMO_GITHUB_TOKEN"]})
+JSON.parse(response.body)
+# =>
+    {"data" =>
+      {"viewer" =>
+        {"login" => "duckinator"}}}
+```
+
 ## 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.

data/lib/okay/graphql.rb

@@ -0,0 +1,124 @@
+require "okay/version"
+require "okay/http"
+require "json"
+
+module Okay
+  # Example usage:
+  #
+  #     require "okay/graphql"
+  #     require "pp"
+  #     query = GraphQL.query {
+  #         viewer {
+  #             login
+  #         }
+  #     }
+  #     response = request.submit!(:github, {bearer_token: ENV["DEMO_GITHUB_TOKEN"]})
+  #     pp JSON.parse(response.body)
+  class GraphQL
+    Container = Struct.new(:value) do
+      def inspect
+        value
+      end
+    end
+
+    class QueryDSL
+      def initialize(indent = 0, &query)
+        @query = ""
+        @indent = indent
+        @indent_str = " " * indent
+        instance_exec(&query)
+      end
+
+      def method_missing(name, *args, **kwargs, &block)
+        query_part = @indent_str + name.to_s
+        if args.length > 0 || kwargs.length > 0
+          query_part += "("
+
+          query_args = []
+          query_args += args unless args.empty?
+          query_args += kwargs.map { |k,v|
+            [k,v.inspect].join(": ")
+          }
+          query_part += query_args.join(", ")
+
+          query_part += ")"
+        end
+
+        if block
+          query_part += " {\n"
+          query_part += QueryDSL.new(@indent + 2, &block).to_s
+          query_part += @indent_str + "}"
+        end
+
+        @query += "#{query_part}\n"
+      end
+
+      def to_s
+        @query
+      end
+    end
+
+    class Query
+      def initialize(&query)
+        @query = QueryDSL.new(&query)
+      end
+
+      def to_s
+        "query {\n" +
+          @query.to_s.gsub(/^/, "  ") +
+        "}"
+      end
+
+      def submit!(url, headers = {})
+        if url == :github
+          url = "https://api.github.com/graphql"
+
+          bearer_token = headers[:bearer_token]
+
+          if bearer_token.nil?
+            raise ArgumentError, "missing keyword: bearer_token"
+          end
+
+          headers = default_github_headers(bearer_token).merge(headers)
+        end
+
+        data = {
+          "query" => to_s
+        }.to_json
+        Okay::HTTP.post(url, headers: headers, data: data)
+      end
+
+    private
+      def default_github_headers(token)
+        {
+          "Accept" => "application/vnd.github.v4.idl",
+          "Authorization" => "bearer #{token}",
+        }
+      end
+    end
+
+    def self.query(&query_)
+      Query.new(&query_)
+    end
+  end
+end
+
+class Object
+  def self.const_missing(name)
+    # HACK: if const_missing is called inside Okay::GraphQL#initialize,
+    #       we wrap the constant name in a GraphQL::Container.
+    #       Otherwise, we re-raise the exception.
+    if caller[2] =~ /^#{Regexp.escape(__FILE__)}:\d+:in `initialize'$/
+      Okay::GraphQL::Container.new(name.to_s)
+    else
+      # Create an exception equivalent to what's normally raised.
+      exception = NameError.new("uninitialized constant #{name.to_s}")
+
+      # Preserve the backtrace.
+      exception.set_backtrace(caller)
+
+      # Raise the exception.
+      raise exception
+    end
+  end
+end

data/lib/okay/http.rb

@@ -1,7 +1,7 @@
-require 'okay/version'
-require 'openssl/better_defaults'
-require 'net/https'
-require 'cacert'
+require "okay/version"
+require "openssl/better_defaults"
+require "net/https"
+require "cacert"
 
 Cacert.set_in_env
 
@@ -60,7 +60,7 @@ module Okay
 
       options = {
         # If the URI starts with "https://", enable SSL/TLS.
-        use_ssl: (uri.scheme == 'https')
+        use_ssl: (uri.scheme == "https")
       }
 
       # Net::HTTP.start() keeps a connection to the host alive
@@ -88,7 +88,7 @@ module Okay
           # Follow a redirect.
           # Decrements +redirect_limit+ while doing so, to avoid redirect loops.
           # NOTE: Does not handle HTTP 307. https://httpstatuses.com/307
-          send_request(:Get, response['location'], parameters, body, headers, redirect_limit - 1)
+          send_request(:Get, response["location"], parameters, body, headers, redirect_limit - 1)
         else
           response
         end

data/lib/okay/version.rb

@@ -1,3 +1,3 @@
 module Okay
-  VERSION = "4.0.0"
+  VERSION = "5.0.0"
 end

data/okay.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: okay
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Ellen Marie Dash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-08 00:00:00.000000000 Z
+date: 2017-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openssl-better_defaults
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Okay, minimalist implementations of common utilities in Ruby. E.g., HTTP
   fetchers.
 email:
@@ -99,6 +113,7 @@ files:
 - bin/console
 - bin/setup
 - lib/okay.rb
+- lib/okay/graphql.rb
 - lib/okay/http.rb
 - lib/okay/version.rb
 - okay.gemspec
@@ -122,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Okay, minimalist implementations of common utilities.