response_matcher 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c15b7492a0b8b2a2285d1248c7bf6ae738932dd
+  data.tar.gz: 797f9192a2b9a9b89d6571f5e47cd26e8ed60508
+SHA512:
+  metadata.gz: c5e810950d3d734b9aa2b64ef765cb0aa7b0f0e8c483d853d325e1cff53fe46caae25cb551e757ea9e2a7445cc7b6dd338846868cc273bdcada397f60f31d597
+  data.tar.gz: 6e0fe70ed06e0f02366aa1c8ce6b1785eff2cd4635ab3597fad61f8977188b674ab2fe19e6586fe62b42684effe922660ce3ab6ebd89f28b4f9f98069f699cec

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yaroslav.bezrukavyi@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in response_matcher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 bezrukavyi
+
+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,162 @@
+# ResponseMatcher
+
+Simple solution to check json response in your request tests as [Rspec](https://github.com/rspec/rspec) matcher
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'response_matcher', '~> 0.1.1'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install response_matcher
+
+## Usage
+
+### Quick start
+
+In ```registration_spec.rb```
+```ruby
+describe RegistrationsController do
+  describe 'POST /auth' do
+    it 'response' do
+      post user_registration_path, params: params
+
+      expect(response).to response_match('schema_path', user: User.last)
+    end
+  end
+end
+```
+
+### You can create your own schema
+
+```
+└─ spec
+    ├─ schemas
+    │   ├─ my_schema.rb
+    │   └─ ...
+    └─ ...
+```
+
+In ```registration_spec.rb```
+```ruby
+expect(response).to response_match('my_schema', user: User.last)
+```
+
+In ```my_schema.rb``` you can describe by ruby language how looks like your response
+
+```ruby
+# All the parameters that you transmit will be available as variables, like 'user'
+{
+  data: {
+    id: user.id,
+    type: user.class.name,
+    attributes: {
+      email: user.email,
+      provider: user.provider,
+      uid: user.uid
+    }
+  }
+}
+```
+
+### You can reuse your schemas in another schemas
+
+```
+└─ spec
+    ├─ schemas
+    │   ├─ my_schema.rb
+    │   ├─ attributes.rb
+    │   └─ ...
+    └─ ...
+```
+
+In ```my_schema.rb```
+```ruby
+# All the parameters that you transmit will be available as variables, like 'user'
+{
+  data: {
+    id: user.id,
+    type: user.class.name,
+    attributes: call('attributes', user: user)
+  }
+}
+```
+
+In ```attributes.rb```
+```ruby
+{
+  email: user.email,
+  provider: user.provider,
+  uid: user.uid
+}
+```
+
+### You can use helpers in your schemas:
+
+```
+└─ spec
+    ├─ schemas
+    │   ├─ my_schema.rb
+    │   ├─ attributes.rb
+    │   └─ ...
+    ├─ helpers
+    │   ├─ my_helper.rb
+    │   └─ ...
+    ├─ rails_helper.rb
+    └─ ...
+```
+
+In ```my_helper.rb```
+```ruby
+module Helpers
+  module MyHelper
+    def entity_class(entity)
+      entity.class.name
+    end
+  end
+end
+```
+
+In ```rails_helper.rb```
+```ruby
+ResponseMatcher::Settings.configure do |config|
+  config.helpers = [Helpers::MyHelper, ...]
+end
+```
+
+In ```my_schema.rb```
+```ruby
+{
+  data: {
+    id: user.id,
+    type: entity_class(user),
+    attributes: call('attributes', user: user)
+  }
+}
+```
+
+### You can set base directory of your schemas:
+
+In ```rails_helper.rb```
+```ruby
+ResponseMatcher::Settings.configure do |config|
+  config.helpers = [Helpers::MyHelper, ...]
+  config.directory = 'spec/schemas/api/v1'
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bezrukavyi/response_matcher
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/response_matcher/parse_schema.rb

@@ -0,0 +1,28 @@
+module ResponseMatcher
+  class ParseSchema
+    def self.new(schema_path, object_hash = {})
+      Settings.config.helpers.each do |helper|
+        include helper
+      end
+
+      attr_accessor(*object_hash.keys, :schema_path, :response, :object_hash)
+
+      super(schema_path, object_hash)
+    end
+
+    def initialize(schema_path, object_hash)
+      @schema_path = schema_path
+      @object_hash = object_hash
+
+      object_hash.each do |name, value|
+        instance_variable_set "@#{name}", value
+      end
+
+      @response = eval(File.read(File.absolute_path("#{Settings.config.directory}/#{schema_path}.rb")))
+    end
+
+    def call(schema_path, object_hash = {})
+      self.class.new(schema_path, object_hash).response
+    end
+  end
+end

data/lib/response_matcher/response_match.rb

@@ -0,0 +1,11 @@
+RSpec::Matchers.define :response_match do |schema_path, object_hash|
+  match do |response|
+    @parse_schema = ResponseMatcher::ParseSchema.new(schema_path, object_hash)
+    @actual = JSON.parse(response.body, symbolize_names: true)
+    @expected = @parse_schema.response
+    @actual == @expected
+  end
+
+  diffable
+  attr_reader :actual, :expected
+end

data/lib/response_matcher/settings.rb

@@ -0,0 +1,8 @@
+module ResponseMatcher
+  class Settings
+    extend ::Dry::Configurable
+
+    setting :helpers, []
+    setting :directory, 'spec/schemas'
+  end
+end

data/lib/response_matcher/version.rb

@@ -0,0 +1,3 @@
+module ResponseMatcher
+  VERSION = '0.1.1'.freeze
+end

data/lib/response_matcher.rb

@@ -0,0 +1,10 @@
+require 'rspec/expectations'
+require 'dry-configurable'
+require 'json'
+require 'response_matcher/settings'
+require 'response_matcher/parse_schema'
+require 'response_matcher/response_match'
+
+module ResponseMatcher
+  # Your code goes here...
+end

data/response_matcher.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'response_matcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'response_matcher'
+  spec.version       = ResponseMatcher::VERSION
+  spec.authors       = ['bezrukavyi']
+  spec.email         = ['yaroslav.bezrukavyi@gmail.com']
+
+  spec.summary       = 'Response Matcher'
+  spec.description   = 'Response Matcher'
+  spec.homepage      = 'https://github.com/bezrukavyi/response_matcher'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dry-configurable', '~> 0.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'pry', '~> 0.10.4'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.50.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require 'response_matcher'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: response_matcher
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- bezrukavyi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+description: Response Matcher
+email:
+- yaroslav.bezrukavyi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/response_matcher.rb
+- lib/response_matcher/parse_schema.rb
+- lib/response_matcher/response_match.rb
+- lib/response_matcher/settings.rb
+- lib/response_matcher/version.rb
+- response_matcher.gemspec
+- spec/spec_helper.rb
+homepage: https://github.com/bezrukavyi/response_matcher
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Response Matcher
+test_files: []