sls_adf 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 320145d0c458d8b27b4851cc1b483fbfa3cd89a6
-  data.tar.gz: d64bfb2d2dfabf65eee07566b1741dcacef22b2a
+SHA256:
+  metadata.gz: df1ccdda043c8f6caa11705d83b919241d788a5d6430277df6ab916672d6f282
+  data.tar.gz: ba3fc0de73314c84e43b1e8c7ab0bb75fa1622e0236c96cf82c5cdf1c7214926
 SHA512:
-  metadata.gz: 339d93578a8a0e79043f27da8ca5056aa41c05062751431b17266309cd0e91505cd528b87df53e2233ddb2a368b4500478e05edad11734a75aabdd2b5aaff6ab
-  data.tar.gz: d3d42b2b1032839dc7aa3b93aab6b4aa96cffb71db70e5efa1772d9eda595da5cae313d4baf9338ac0f81eb5b2c671f9bacdbd72904b6a3c9419cd04676713cf
+  metadata.gz: 34f878df0cda468816e404608acc0d84bcc3b6b3133ef3cc49e7808042f1ba53592b06347403ac1fa2e75daa871a3e41436011ef2a001d5a01005b2c05006c50
+  data.tar.gz: 60f820067bfb460b9adb7d3a6424f289d58537f996c074a520c4f7aad846fec782f94e695306b1449380a557e168d0e0c33e0d23797a8f02c2ce43b10b73b40b

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    sls_adf (0.0.1)
+    sls_adf (0.0.2)
       graphql-client (~> 0.12)
       typhoeus (~> 1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.4)
+    activesupport (5.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -23,16 +23,16 @@ GEM
     dotenv (2.2.1)
     ethon (0.11.0)
       ffi (>= 1.3.0)
-    ffi (1.9.18)
-    graphql (1.7.7)
+    ffi (1.9.23)
+    graphql (1.7.13)
     graphql-client (0.12.2)
       activesupport (>= 3.0, < 6.0)
       graphql (~> 1.6)
     hashdiff (0.3.7)
-    i18n (0.9.1)
+    i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
-    minitest (5.10.3)
+    minitest (5.11.3)
     public_suffix (3.0.1)
     rake (10.5.0)
     rdoc (6.0.0)
@@ -58,7 +58,7 @@ GEM
     thread_safe (0.3.6)
     typhoeus (1.3.0)
       ethon (>= 0.9.0)
-    tzinfo (1.2.4)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
     webmock (3.1.1)
       addressable (>= 2.3.6)
@@ -79,4 +79,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.16.0
+   1.16.1

data/README.md

@@ -1,4 +1,7 @@
-[![Build Status](https://travis-ci.org/moexmen/sls_adf.svg?branch=master)](https://travis-ci.org/moexmen/sls_adf) [![Maintainability](https://api.codeclimate.com/v1/badges/5d7c2801d4a37ecf8cdf/maintainability)](https://codeclimate.com/github/moexmen/sls_adf/maintainability)
+[![Gem Version](https://badge.fury.io/rb/sls_adf.svg)](https://badge.fury.io/rb/sls_adf)
+[![Build Status](https://travis-ci.org/moexmen/sls_adf.svg?branch=master)](https://travis-ci.org/moexmen/sls_adf)
+[![Inline docs](http://inch-ci.org/github/moexmen/sls_adf.svg?branch=master)](http://inch-ci.org/github/moexmen/sls_adf)
+[![Maintainability](https://api.codeclimate.com/v1/badges/5d7c2801d4a37ecf8cdf/maintainability)](https://codeclimate.com/github/moexmen/sls_adf/maintainability)
 
 # SLS ADF - Ruby Client Library
 
@@ -66,9 +69,15 @@ extended or replaced to support different use cases.
 
 #### Customised GraphQL Calls
 
-`sls_adf` provides pre-defined GraphQL calls to ADF. Should you require a different call,
-you may define new GraphQL queries, mutations or fragments. Thereafter, you can construct
-your own class that uses these templates and inherits from `SlsAdf::Base`.
+`sls_adf` provides pre-defined GraphQL calls to ADF. Should you require other calls,
+you may:
+
+1. Declare your custom GraphQL queries or mutations using the
+   [graphql-client DSL](https://github.com/github/graphql-client#defining-queries),
+   then execute them using `SlsAdf.query` with the appropriate variables.
+2. For easy reuse, create a new class that inherits from `SlsAdf::Base` to wrap your custom
+   queries, mutations or fragments.
+
 
 ## Development
 

data/lib/sls_adf/base.rb

@@ -6,13 +6,18 @@ module SlsAdf
     class << self
       protected
 
-      # Helper method used to execute queries.
-      #
-      # @param [GraphQL::Client::Definition] template The template to be used.
-      # @param [Hash] vars Variables to be passed into the query.
-      def execute_query(template, vars = {})
-        SlsAdf.client.query(template, variables: vars)
+      # Helper method used to execute queries. See {SlsAdf.query}.
+      def execute_query(*args)
+        SlsAdf.query(*args)
       end
     end
   end
+
+  # Syntactic sugar to reduce verbosity of standard queries.
+  #
+  # @param [GraphQL::Client::Definition] template The template to be used.
+  # @param [Hash] vars Variables to be passed into the query.
+  def self.query(template, vars = {})
+    SlsAdf.client.query(template, variables: vars)
+  end
 end

data/lib/sls_adf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SlsAdf
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sls_adf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Toh Weiqing
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2018-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql-client
@@ -204,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby client library for SLS (in progress).