graphql-persisted_queries 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c766b357d35d1bda4dfba34a5a633260a0dfe3593189f1d60b35d5973b5c18a4
-  data.tar.gz: 6182e3cdb5ce2ed6194b7ee4eef87ad2c3194299904bd1ecaf29fc5179c1358e
+  metadata.gz: d1315da48bdcf5bca972f884cc38d12aae1016355198d31dc8fdadf445b6662a
+  data.tar.gz: eb8daf60333fe6683bc68e6eb63e0ef5528dba116b33ab084b2585b6465e3394
 SHA512:
-  metadata.gz: 6ee805aae51f2ecf5c055eb5c3d02b20873369a990498f0b2e75348ab62cf8192945b9716d87c616772e2c07b000fd8b73a238e45124cd7e849e3d3041e41cf6
-  data.tar.gz: 49b7cbe475f09c7f4ec6e4b11a1dbcb3d86a03fcd6d63ef4acf977e59aff6c6e223e858d24f96f6895d8ccee9495f0ffbd623a28e48eec89ccd895fa284cd4d0
+  metadata.gz: b80a7cbfe97b3e6c9912732867576b2be8bf682c1a91728462a18aa844df4db12610cb58da16e62d45f75f7256a73370b72d04abb4691503b64eb59909f32b7b
+  data.tar.gz: 0dd02d28cc56c2ceab91f3299dcf5252a2528eaf796011dd36a7213fbf77c6a1cbe2fac8486161bb1bd7ca6d1f4d24138dbb6b2e12c029e460db0749fef991b9

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 0.1.1 (2019-10-24)
+
+- [PR#7](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/7) Improved Redis configuration – added `Proc` and `ConnectionPool` support ([@DmitryTsepelev][])
+
 ## 0.1.0 (2019-10-21)
 
 - Initial version ([@DmitryTsepelev][])

data/README.md

@@ -63,11 +63,27 @@ All the queries are stored in memory by default, but you can easily switch to _r
 
 ```ruby
 class GraphqlSchema < GraphQL::Schema
-  use GraphQL::PersistedQueries, store: :redis, redis_url: ENV["MY_REDIS_URL"]
+  use GraphQL::PersistedQueries, store: :redis, redis_client: { redis_url: ENV["MY_REDIS_URL"] }
 end
 ```
 
-If you have `ENV["REDIS_URL"]` configured – you don't need to pass it explicitly. Also, you can pass `:redis_host`, `:redis_port` and `:redis_db_name` to build the URL from scratch or configure Redis client as you want and pass it as the `:client` option.
+If you have `ENV["REDIS_URL"]` configured – you don't need to pass it explicitly. Also, you can pass `:redis_host`, `:redis_port` and `:redis_db_name` inside the `:redis_client` hash to build the URL from scratch or pass the configured `Redis` or `ConnectionPool` object:
+
+```ruby
+class GraphqlSchema < GraphQL::Schema
+  use GraphQL::PersistedQueries,
+      store: :redis,
+      redis_client: { redis_host: "127.0.0.2", redis_port: "2214", redis_db_name: "7" }
+  # or
+  use GraphQL::PersistedQueries,
+      store: :redis,
+      redis_client: Redis.new(url: "redis://127.0.0.2:2214/7")
+  # or
+  use GraphQL::PersistedQueries,
+      store: :redis,
+      redis_client: ConnectionPool.new { Redis.new(url: "redis://127.0.0.2:2214/7") }
+end
+```
 
 ## Alternative hash functions
 

data/graphql-persisted_queries.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rubocop", "0.75"
   spec.add_development_dependency "redis"
+  spec.add_development_dependency "connection_pool"
 end

data/lib/graphql/persisted_queries/store_adapters/redis_client_builder.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module PersistedQueries
+    module StoreAdapters
+      # Builds Redis object instance based on passed hash
+      class RedisClientBuilder
+        def initialize(redis_url: nil, redis_host: nil, redis_port: nil, redis_db_name: nil)
+          require "redis"
+
+          @redis_url = redis_url
+          @redis_host = redis_host
+          @redis_port = redis_port
+          @redis_db_name = redis_db_name
+        rescue LoadError => e
+          msg = "Could not load the 'redis' gem, please add it to your gemfile or " \
+                "configure a different adapter, e.g. use GraphQL::PersistedQueries, store: :memory"
+          raise e.class, msg, e.backtrace
+        end
+
+        def build
+          if @redis_url && (@redis_host || @redis_port || @redis_db_name)
+            raise ArgumentError, "redis_url cannot be passed along with redis_host, redis_port " \
+                                 "or redis_db_name options"
+          end
+
+          ::Redis.new(url: @redis_url || build_redis_url)
+        end
+
+        private
+
+        DEFAULT_REDIS_DB = "0"
+
+        def build_redis_url
+          db_name = @redis_db_name || DEFAULT_REDIS_DB
+          base_url = ENV["REDIS_URL"] || "redis://#{@redis_host}:#{@redis_port}"
+          URI.join(base_url, db_name).to_s
+        end
+      end
+    end
+  end
+end

data/lib/graphql/persisted_queries/store_adapters/redis_store_adapter.rb

@@ -1,65 +1,49 @@
 # frozen_string_literal: true
 
+require "graphql/persisted_queries/store_adapters/redis_client_builder"
+
 module GraphQL
   module PersistedQueries
     module StoreAdapters
       # Redis adapter for storing persisted queries
       class RedisStoreAdapter < BaseStoreAdapter
-        attr_reader :storage
-
-        def initialize(client: nil, **options)
-          require "redis"
-
-          if client && options.any?
-            raise ArgumentError, "client cannot be passed along with redis_url, redis_host" \
-                                 ", redis_port or redis_db_name options"
-          end
-
-          @storage = client || configure_redis_client(options)
-        rescue LoadError => e
-          msg = "Could not load the 'redis' gem, please add it to your gemfile or " \
-                "configure a different adapter, e.g. use GraphQL::PersistedQueries, store: :memory"
-          raise e.class, msg, e.backtrace
+        def initialize(redis_client:)
+          @redis_proc = build_redis_proc(redis_client)
         end
 
         def fetch_query(hash)
-          storage.get(key_for(hash))
+          @redis_proc.call { |redis| redis.get(key_for(hash)) }
         end
 
         def save_query(hash, query)
-          storage.set(key_for(hash), query)
+          @redis_proc.call { |redis| redis.set(key_for(hash), query, ex: 24 * 60 * 60) }
         end
 
         private
 
         def key_for(hash)
-          "persisted-query-#{hash}"
+          "graphql-persisted-query:#{hash}"
         end
 
-        # rubocop:disable Metrics/LineLength
-        def configure_redis_client(redis_url: nil, redis_host: nil, redis_port: nil, redis_db_name: nil)
-          if redis_url && (redis_host || redis_port || redis_db_name)
-            raise ArgumentError, "redis_url cannot be passed along with redis_host, redis_port " \
-                                 "or redis_db_name options"
+        # rubocop: disable Metrics/MethodLength
+        # rubocop: disable Metrics/CyclomaticComplexity
+        # rubocop: disable Metrics/PerceivedComplexity
+        def build_redis_proc(redis_client)
+          if redis_client.is_a?(Hash)
+            build_redis_proc(RedisClientBuilder.new(redis_client).build)
+          elsif redis_client.is_a?(Proc)
+            redis_client
+          elsif defined?(::Redis) && redis_client.is_a?(::Redis)
+            proc { |&b| b.call(redis_client) }
+          elsif defined?(ConnectionPool) && redis_client.is_a?(ConnectionPool)
+            proc { |&b| redis_client.with { |r| b.call(r) } }
+          else
+            raise ArgumentError, ":redis_client accepts Redis, ConnectionPool, Hash or Proc only"
           end
-
-          redis_url ||= build_redis_url(
-            redis_host: redis_host,
-            redis_port: redis_port,
-            redis_db_name: redis_db_name
-          )
-
-          Redis.new(url: redis_url)
-        end
-        # rubocop:enable Metrics/LineLength
-
-        DEFAULT_REDIS_DB = "0"
-
-        def build_redis_url(redis_host: nil, redis_port: nil, redis_db_name: nil)
-          redis_db_name ||= DEFAULT_REDIS_DB
-          redis_base_url = ENV["REDIS_URL"] || "redis://#{redis_host}:#{redis_port}"
-          URI.join(redis_base_url, redis_db_name).to_s
         end
+        # rubocop: enable Metrics/MethodLength
+        # rubocop: enable Metrics/CyclomaticComplexity
+        # rubocop: enable Metrics/PerceivedComplexity
       end
     end
   end

data/lib/graphql/persisted_queries/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module PersistedQueries
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-persisted_queries
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2019-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  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: Persisted queries for graphql-ruby
 email:
 - dmitry.a.tsepelev@gmail.com
@@ -108,6 +122,7 @@ files:
 - lib/graphql/persisted_queries/store_adapters.rb
 - lib/graphql/persisted_queries/store_adapters/base_store_adapter.rb
 - lib/graphql/persisted_queries/store_adapters/memory_store_adapter.rb
+- lib/graphql/persisted_queries/store_adapters/redis_client_builder.rb
 - lib/graphql/persisted_queries/store_adapters/redis_store_adapter.rb
 - lib/graphql/persisted_queries/version.rb
 homepage: https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries