webmock-graphql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 00b6f39ab6614ae9e285b286f37df1c62c4f25c3e37223c51a66b5c399b43878
+  data.tar.gz: e985a530359a1ee5967a8c8fa080156ea4f78b67376ce333d34a4feeae835e50
+SHA512:
+  metadata.gz: 80b5f077015dbd880805cec55dbe5af810ab6103e3be7f3f3b1a8efb5a3c29e49aab0bf9480581286711535906be0bc5591b3e17d2a6efc9a70f4058a64f7c77
+  data.tar.gz: 2406f0b3be70d087a51f9fc52478b9ce7c1b09782d82826170e2085e6b765c9803b7f8c7964f80527beb10d9f1986207706fd48d8c3689b1e9cba048fad85797

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 3.2

data/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "editor.formatOnSave": true,
+    "[ruby]": {
+        "editor.defaultFormatter": "testdouble.vscode-standard-ruby"
+    }
+}

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-06-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in webmock-graphql.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 qsona
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Webmock::Graphql
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add webmock-graphql
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install webmock-graphql
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/qsona/webmock-graphql.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/webmock/graphql/rspec.rb

@@ -0,0 +1,5 @@
+require_relative "graphql/stub_graphql_request"
+
+RSpec.configure do |config|
+  config.include Webmock::Graphql::StubGraphqlRequest
+end

data/lib/webmock/graphql/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Webmock
+  module Graphql
+    VERSION = "0.1.0"
+  end
+end

data/lib/webmock/graphql.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require_relative "graphql/version"
+
+module Webmock
+  module Graphql
+    # Example:
+    #
+    # Webmock::Graphql.register(:hoge, "query($foo: Int!) { bar baz }") do
+    #   params do
+    #     foo
+    #     bar { 1 } # default value
+    #   end
+    #   variables do
+    #     { foo: foo }
+    #   end
+    #   data do
+    #     { bar: bar, baz: 2 }
+    #   end
+    # end
+    class BuilderContextClassFactory
+      def self.new(query)
+        Class.new do
+          @query = query
+
+          def initialize(**args)
+            args.each do |name, value|
+              instance_variable_set("@#{name}", value)
+            end
+          end
+
+          def variables
+            pr = self.class.variables_proc
+            pr && instance_exec(&pr)
+          end
+
+          def data
+            pr = self.class.data_proc
+            pr && instance_exec(&pr)
+          end
+
+          def errors
+            pr = self.class.errors_proc
+            pr && instance_exec(&pr)
+          end
+
+          class << self
+            attr_reader :query
+            attr_accessor :variables_proc, :data_proc, :errors_proc
+          end
+
+          def query
+            self.class.query
+          end
+        end
+      end
+    end
+
+    class ParamsContext
+      def initialize(builder_context_class)
+        @builder_context_class = builder_context_class
+      end
+      attr_reader :builder_context_class
+
+      def method_missing(name, &block)
+        builder_context_class.define_method(name) do
+          # self == builder_context instance
+          vname = "@#{name}"
+          if instance_variable_defined?(vname)
+            instance_variable_get(vname)
+          elsif block
+            instance_exec(&block)
+          else
+            raise "#{name} is not passed"
+          end
+        end
+      end
+
+      def respond_to_missing?(sym, include_private)
+        true
+      end
+    end
+
+    class RegisterContext
+      # attr_reader :variables_proc, :data_proc, :errors_proc
+      attr_reader :builder_context_class
+      def initialize(query)
+        @builder_context_class = BuilderContextClassFactory.new(query)
+      end
+
+      def params(&block)
+        params_context = ParamsContext.new(@builder_context_class)
+        params_context.instance_exec(&block)
+      end
+
+      def variables(&block)
+        builder_context_class.variables_proc = block
+      end
+
+      def data(&block)
+        builder_context_class.data_proc = block
+      end
+
+      def errors(&block)
+        builder_context_class.errors_proc = block
+      end
+    end
+
+    @stub_hash = {}
+    class << self
+      attr_accessor :default_url
+      attr_reader :stub_hash
+
+      def register(name, query, &block)
+        raise "stub #{name} is already registered" if stub_hash[name]
+
+        register_context = RegisterContext.new(query)
+        register_context.instance_exec(&block)
+
+        stub_hash[name] = register_context.builder_context_class
+      end
+
+      def reset!
+        self.default_url = nil
+        @stub_hash = {}
+      end
+    end
+
+    module StubGraphqlRequest
+      # stub_graphql_request(:hoge, a: 1, b: 2)
+      def stub_graphql_request(name, url = nil, **args)
+        builder_context_class = Webmock::Graphql.stub_hash[name]
+        raise "stub #{name} is not registered" unless builder_context_class
+
+        stub_graphql_context = builder_context_class.new(**args)
+
+        url ||= Webmock::Graphql.default_url
+        raise "url is not set" if url.nil?
+
+        WebMock.stub_request(:post, url).with(
+          body: {
+            query: stub_graphql_context.query,
+            variables: stub_graphql_context.variables
+          }
+        ).to_return(
+          body: {
+            data: stub_graphql_context.data,
+            errors: stub_graphql_context.errors
+          }.to_json,
+          headers: {"Content-Type" => "application/json"}
+        )
+      end
+    end
+
+    # enable `Webmock::Graphql.stub_graphql_request`
+    extend StubGraphqlRequest
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: webmock-graphql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- qsona
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Library for stubbing graphql request (from ruby to other services), wrapper
+  of webmock
+email:
+- mori.jmk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- ".vscode/settings.json"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/webmock/graphql.rb
+- lib/webmock/graphql/builder_context.rb
+- lib/webmock/graphql/rspec.rb
+- lib/webmock/graphql/version.rb
+homepage: https://github.com/qsona/webmock-graphql
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/qsona/webmock-graphql
+  source_code_uri: https://github.com/qsona/webmock-graphql
+  changelog_uri: https://github.com/qsona/webmock-graphql/tree/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Library for stubbing graphql request
+test_files: []