fixturama 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64d9722c641abfd4aa64fbf45b8f1177f768d1b8d2b99a89aa824e1f64db9417
-  data.tar.gz: e1186c8944916943bbab46584747553b07b9d5cfc4e9d875d1a401fc8bd7017a
+  metadata.gz: 5bfb62ba99d427f8a3f03b6d46a0fb7e6712dd31bfff6da7c17fb075cfa930f0
+  data.tar.gz: fa1b0359c0681a73723a915dd499945602b350b3b802b68e6962a66753a5d208
 SHA512:
-  metadata.gz: 29d44cd1b06c482ba40df2d4397c064888a64ae1f9a0a4151aa581bf81a83e9ca1a5e84c052340d515032d0f580f11418f9838a5efe00fd722401117248a0311
-  data.tar.gz: 2b8a86f7fffdb20bae92839790254e052d2dbbbb39172003c9cfb4439620c782e4bc3f2ccdd985540dcba4d19e1fc228a3f7d940d58a865ad289f2f265427589
+  metadata.gz: 987b0cf303e78879b18278d85ace7cf26261e6c76000b0081571cb40a3dcf763435cb5560de122bf3a466b9c781684c8ed8d183697fbd1b84aa619c8409e34c8
+  data.tar.gz: d85486458d90dbff1e3f2136c5862e081aa1a1861bb5e6320fb68bbc258d11ce1e978de5603c900080ef719809e97a4d0bf793a46c8f90af33e7a6626d258835

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
   StyleGuideCopsOnly: true
   TargetRubyVersion:  2.3
 
-Metrics/LineLength:
+Layout/LineLength:
   AllowHeredoc: true
   AllowURI: true
   URISchemes:

data/.travis.yml

@@ -10,14 +10,8 @@ script:
   - bundle exec rubocop
 rvm:
   - 2.3.0
-  - 2.6.0
-  - jruby-9.2.0.0
+  - 2.7.0
   - ruby-head
-  - jruby-head
-env:
-  global:
-    - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-head

data/CHANGELOG.md

@@ -5,6 +5,30 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.1.0] - [2020-02-09]
+
+### Added
+
+- Stubbing of the HTTP requests using webmock (nepalez)
+
+  ```yaml
+  ---
+  - url: example.com/foo
+    method: get
+    body: foobar
+    query:
+      foo: bar
+    basic_auth:
+      user: foo
+      password: bar
+    headers:
+      Accept: utf-8
+    responses:
+      - status: 200
+        body: foobar
+      - status: 404
+  ```
+
 ## [0.0.7] - [2019-07-01]
 
 ### Added
@@ -175,3 +199,4 @@ This is a first public release with features extracted from production app.
 [0.0.5]: https://github.com/nepalez/fixturama/compare/v0.0.4...v0.0.5
 [0.0.6]: https://github.com/nepalez/fixturama/compare/v0.0.5...v0.0.6
 [0.0.7]: https://github.com/nepalez/fixturama/compare/v0.0.6...v0.0.7
+[0.1.0]: https://github.com/nepalez/fixturama/compare/v0.0.7...v0.1.0

data/README.md

@@ -133,12 +133,25 @@ For message chains:
 - `arguments` (optional) for specific arguments
 - `actions` for an array of actions for consecutive invocations of the chain
 
+Every action either `return` some value, or `raise` some exception
+
 For constants:
 
 - `const` for stubbed constant
 - `value` for a value of the constant
 
-Every action either `return` some value, or `raise` some exception
+For http requests:
+
+- `url` or `uri` for the URI of the request (treats values like `/.../` as regular expressions)
+- `method` for the specific http-method (like `get` or `post`)
+- `body` for the request body (treats values like `/.../` as regular expressions)
+- `headers` for the request headers
+- `query` for the request query
+- `basic_auth` for the `user` and `password` of basic authentication
+- `response` or `responses` for consecutively envoked responses with keys:
+    - `status`
+    - `body`
+    - `headers`
 
 ```yaml
 # ./stubs.yml
@@ -170,6 +183,21 @@ Every action either `return` some value, or `raise` some exception
 
 - const: NOTIFIER_TIMEOUT_SEC
   value: 10
+
+# Examples for stubbing HTTP
+- uri: /example.com/foo/ # regexp!
+  method: delete
+  basic_auth:
+    user: foo
+    password: bar
+  responses:
+    - status: 200 # for the first call
+    - status: 404 # for any other call
+
+- uri: htpps://example.com/foo # exact string!
+  method: delete
+  responses:
+    - status: 401
 ```
 
 ```graphql

data/fixturama.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "fixturama"
-  gem.version  = "0.0.7"
+  gem.version  = "0.1.0"
   gem.author   = "Andrew Kozin (nepalez)"
   gem.email    = "andrew.kozin@gmail.com"
   gem.homepage = "https://github.com/nepalez/fixturama"
@@ -15,9 +15,10 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency "factory_bot", "~> 4.0"
   gem.add_runtime_dependency "rspec", "~> 3.0"
-  gem.add_runtime_dependency "hashie", "~> 3.6"
+  gem.add_runtime_dependency "hashie", "~> 3.0"
+  gem.add_runtime_dependency "webmock", "~> 3.0"
 
   gem.add_development_dependency "rake", "~> 10"
-  gem.add_development_dependency "rspec-its", "~> 1.2"
+  gem.add_development_dependency "rspec-its", "~> 1.0"
   gem.add_development_dependency "rubocop", "~> 0.49"
 end

data/lib/fixturama.rb

@@ -3,6 +3,7 @@ require "factory_bot"
 require "hashie/mash"
 require "json"
 require "rspec"
+require "webmock/rspec"
 require "yaml"
 
 module Fixturama

data/lib/fixturama/stubs.rb

@@ -5,6 +5,7 @@ module Fixturama
   class Stubs
     require_relative "stubs/chain"
     require_relative "stubs/const"
+    require_relative "stubs/request"
 
     #
     # Register new action and apply the corresponding stub
@@ -35,14 +36,15 @@ module Fixturama
       stub = case stub_type(options)
              when :message_chain then Chain.new(options)
              when :constant      then Const.new(options)
+             when :request       then Request.new(options)
              end
 
-      @stubs[stub.to_s] ||= stub if stub
+      @stubs[stub.key] ||= stub if stub
     end
 
     def stub_type(options)
-      return :message_chain if options[:class] || options[:object]
-      return :constant      if options[:const]
+      key = (TYPES.keys & options.keys).first
+      return TYPES[key] if key
 
       raise ArgumentError, <<~MESSAGE
         Cannot figure out what to stub from #{options}.
@@ -50,6 +52,26 @@ module Fixturama
       MESSAGE
     end
 
+    # Matches keys to the type of the stub
+    TYPES = {
+      arguments: :message_chain,
+      actions: :message_chain,
+      basic_auth: :request,
+      body: :request,
+      chain: :message_chain,
+      class: :message_chain,
+      const: :constant,
+      headers: :request,
+      http_method: :request,
+      object: :message_chain,
+      query: :request,
+      response: :request,
+      responses: :request,
+      uri: :request,
+      url: :request,
+      value: :constant,
+    }.freeze
+
     def symbolize(options)
       Hash(options).transform_keys { |key| key.to_s.to_sym }
     end

data/lib/fixturama/stubs/chain.rb

@@ -16,6 +16,7 @@ module Fixturama
       "#{receiver}.#{messages.join(".")}"
     end
     alias to_str to_s
+    alias key to_s
 
     #
     # Register new action for some arguments

data/lib/fixturama/stubs/const.rb

@@ -13,6 +13,7 @@ module Fixturama
       const.to_s
     end
     alias to_str to_s
+    alias key to_s
 
     #
     # Overload the definition for the constant

data/lib/fixturama/stubs/request.rb

@@ -0,0 +1,98 @@
+#
+# Stubbed request
+#
+class Fixturama::Stubs::Request
+  require_relative "request/response"
+  require_relative "request/responses"
+
+  def to_s
+    "#{http_method.upcase} #{uri.to_s == "" ? "*" : uri}"
+  end
+  alias to_str to_s
+
+  # every stub is unique
+  alias key hash
+  def update!(_); end
+
+  def apply!(example)
+    stub = example.stub_request(http_method, uri)
+    stub = stub.with(request) if request.any?
+    stub.to_return { |_| responses.next }
+  end
+
+  private
+
+  attr_reader :options
+
+  def initialize(options)
+    @options = options
+    with_error { @options = Hash(options).symbolize_keys }
+  end
+
+  HTTP_METHODS = %i[get post put patch delete head options any].freeze
+
+  def http_method
+    value = with_error("method") { options[:method]&.to_sym&.downcase } || :any
+    return value if HTTP_METHODS.include?(value)
+
+    raise ArgumentError, "Invalid HTTP method #{value} in #{@optons}"
+  end
+
+  def uri
+    with_error("uri") { maybe_regexp(options[:uri] || options[:url]) }
+  end
+
+  def headers
+    with_error("headers") do
+      Hash(options[:headers]).transform_keys(&:to_s) if options.key?(:headers)
+    end
+  end
+
+  def query
+    with_error("query") do
+      Hash(options[:query]).transform_keys(&:to_s) if options.key?(:query)
+    end
+  end
+
+  def body
+    with_error("body") do
+      case options[:body]
+      when NilClass then nil
+      when Hash then options[:body]
+      else maybe_regexp(options[:body])
+      end
+    end
+  end
+
+  def basic_auth
+    with_error("basic auth") do
+      value = options[:auth] || options[:basic_auth]
+      Hash(value).transform_keys(&:to_s).values_at("user", "pass") if value
+    end
+  end
+
+  def request
+    @request ||= {
+      headers: headers,
+      body: body,
+      query: query,
+      basic_auth: basic_auth
+    }.select { |_, val| val }
+  end
+
+  def responses
+    @responses ||= Responses.new(options[:response] || options[:responses])
+  end
+
+  def with_error(part = nil)
+    yield
+  rescue RuntimeError
+    message = ["Cannot extract a request", part, "from #{options}"].join(" ")
+    raise ArgumentError, message, __FILE__, __LINE__ - 1
+  end
+
+  def maybe_regexp(str)
+    str = str.to_s
+    str[%r{\A/.*/\z}] ? Regexp.new(str[1..-2]) : str
+  end
+end

data/lib/fixturama/stubs/request/response.rb

@@ -0,0 +1,43 @@
+class Fixturama::Stubs::Request
+  class Response
+    def to_h
+      { status:  status, body: body, headers: headers }.select { |_, val| val }
+    end
+
+    private
+
+    def initialize(options)
+      @options = options
+      @options = with_error { Hash(options).transform_keys(&:to_sym) }
+    end
+
+    attr_reader :options
+
+    def status
+      with_error("status") { options[:status]&.to_i } || 200
+    end
+
+    def body
+      with_error("body") do
+        case options[:body]
+        when NilClass then nil
+        when Hash then JSON.dump(options[:body])
+        else options[:body].to_s
+        end
+      end
+    end
+
+    def headers
+      with_error("headers") do
+        Hash(options[:headers]).map { |k, v| [k.to_s, v.to_s] }.to_h
+      end
+    end
+
+    def with_error(part = nil)
+      yield
+    rescue RuntimeError
+      text = ["Cannot extract a response", part, "from #{options}"].join(" ")
+      raise ArgumentError, text, __FILE__, __LINE__ - 1
+    end
+  end
+end

data/lib/fixturama/stubs/request/responses.rb

@@ -0,0 +1,20 @@
+class Fixturama::Stubs::Request
+  class Responses
+    def next
+      list.count > @count ? list[@count].tap { @count += 1 } : list.last
+    end
+
+    private
+
+    def initialize(list)
+      @count = 0
+      list ||= [{ status: 200 }]
+      @list = case list
+              when Array then list.map { |item| Response.new(item).to_h }
+              else [Response.new(list).to_h]
+              end
+    end
+
+    attr_reader :list
+  end
+end

data/spec/fixturama/seed_fixture/_spec.rb

@@ -26,7 +26,10 @@ RSpec.describe "seed_fixture" do
 
   it "runs the factory", aggregate_failures: true do
     expect(FactoryBot).to receive(:create_list).with(:foo, 1, :baz, qux: 42)
-    expect(FactoryBot).to receive(:create_list).with(:foo, 3, :bar, {})
+    expect(FactoryBot).to receive(:create_list) do |*args, **opts|
+      expect(args).to eq [:foo, 3, :bar]
+      expect(opts).to be_empty
+    end
 
     subject
   end

data/spec/fixturama/stub_fixture/_spec.rb

@@ -93,4 +93,28 @@ RSpec.describe "stub_fixture" do
       expect(TIMEOUT).to eq 10
     end
   end
+
+  context "when http request stubbed" do
+    before { stub_fixture "#{__dir__}/stub.yml" }
+
+    it "stubs the request properly" do
+      req = Net::HTTP::Get.new("/foo")
+      res = Net::HTTP.start("www.example.com") { |http| http.request(req) }
+
+      expect(res.code).to eq "200"
+      expect(res.body).to eq "foo"
+      expect(res["Content-Length"]).to eq "3"
+    end
+
+    def delete_request
+      req = Net::HTTP::Delete.new("/foo")
+      Net::HTTP.start("www.example.com") { |http| http.request(req) }
+    end
+
+    it "stubs repetitive requests properly" do
+      expect(delete_request.code).to eq "200"
+      expect(delete_request.code).to eq "404"
+      expect(delete_request.code).to eq "404"
+    end
+  end
 end

data/spec/fixturama/stub_fixture/stub.yml

@@ -58,3 +58,16 @@
 
 - const: TIMEOUT
   value: 10
+
+- method: get
+  uri: www.example.com/foo
+  responses:
+    - body: foo
+      headers:
+        Content-Length: 3
+
+- method: delete
+  uri: /example.com/foo/ # Regexp!
+  responses:
+    - status: 200
+    - status: 404 # for any request except for the first one

metadata

@@ -1,100 +1,114 @@
 --- !ruby/object:Gem::Specification
 name: fixturama
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kozin (nepalez)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2020-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-  type: :runtime
+  name: factory_bot
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  type: :runtime
+  name: rspec
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.0'
+  name: hashie
+  prerelease: false
   type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: webmock
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
-  type: :development
+  name: rake
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
+        version: '1.0'
+  name: rspec-its
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.49'
-  type: :development
+  name: rubocop
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.49'
-description: 
+description:
 email: andrew.kozin@gmail.com
 executables: []
 extensions: []
@@ -126,6 +140,9 @@ files:
 - lib/fixturama/stubs/chain/actions/return.rb
 - lib/fixturama/stubs/chain/arguments.rb
 - lib/fixturama/stubs/const.rb
+- lib/fixturama/stubs/request.rb
+- lib/fixturama/stubs/request/response.rb
+- lib/fixturama/stubs/request/responses.rb
 - lib/fixturama/utils.rb
 - spec/fixturama/load_fixture/_spec.rb
 - spec/fixturama/load_fixture/data.json
@@ -140,7 +157,7 @@ homepage: https://github.com/nepalez/fixturama
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -155,8 +172,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
 specification_version: 4
 summary: A set of helpers to prettify specs with fixtures
 test_files: