rspec-api_helpers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1059a5b7da87e98a2292e3225d9c7eb3d686c8c1
+  data.tar.gz: 01ea35dc008e61c27fd7a84088c3773c790b2fb9
+SHA512:
+  metadata.gz: 702e77dfb79183d12f464760f5b969555f3dcb6734b77c0def10a7773b098791b4a8377c8c977f7b4e5ed0c8ea29fa5e7a0f754ab83d0e6aff7798712150e663
+  data.tar.gz: ab883d0ce0e862788ef40512c239c955ba14ec9770332bfc74485619832385aefe84a845031f4e887d73eef12c83bf5e8343edd9b4188ee5e08816efb6dfd6a7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Filippos Vasilakis
+
+MIT License
+
+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,63 @@
+# Rspec::ApiHelpers
+
+Usefull Rspec helpers for APIs (currently only ActiveModel Serializers are supported)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-api_helpers', github: 'kollegorna/rspec-api_helpers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-api_helpers
+
+## Usage
+This Gem expects you to have set your rspec to use Rake::Test helpers as described
+[here](https://gist.github.com/alex-zige/5795358) because it checks `last_response`
+attributes.
+
+### Examples
+
+```ruby
+it_returns_status(200)
+```
+It checks if the HTTP response status is 200.
+
+```ruby
+it_returns_attributes(resource: 'user', model: '@user', only: [
+  :email, :name
+])
+```
+It checks if the HTTP body contains an AMS json that has :email and :name attributes and
+compares them with '@user' variable's attributes.
+
+```ruby
+it_returns_more_attributes(
+  resource: 'user',
+  model: 'User.last!',
+  only: [:updated_at, :created_at],
+  modifier: 'iso8601'
+)
+```
+It checks if the HTTP body contains an AMS json that has :updated_at and :created_at
+attributes and compares them with '@user' variable's attributes after it applies modifier.
+
+```ruby
+it_returns_resources(root: 'users', number: 5)
+```
+It checks if the HTTP body contains an AMS json with an array of 'users'.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rspec-api_helpers/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rspec/api_helpers/example_group_methods.rb

@@ -0,0 +1,58 @@
+module Rspec
+  module ApiHelpers
+    module ExampleGroupMethods
+      def it_returns_status(status)
+        it 'returns the correct status' do
+          expect(last_response.status).to eql(status)
+        end
+      end
+
+      def it_returns_attributes(resource:, model:, only: [], modifier: nil)
+        it "expects returned resource to have the following model's attributes" do
+          @api_resource = objectize_resource(last_response.body, root: resource)
+
+          @model = eval(model)
+          if @model.is_a? Hash
+            @model = object_hash(@model)
+          end
+
+          if only
+            only.each do |attribute|
+              begin
+                if modifier
+                  expect(@api_resource.send(attribute)).to(
+                    eql(@model.send(attribute).send(modifier.to_sym))
+                  )
+                else
+                  expect(@api_resource.send(attribute)).to eql(@model.send(attribute))
+                end
+              rescue RSpec::Expectations::ExpectationNotMetError => e
+                e.message << "failed at model attribute: #{attribute}"
+                raise e
+              end
+            end
+          end
+        end
+
+      end
+      alias_method :it_returns_db_model, :it_returns_attributes
+      alias_method :it_returns_more_attributes, :it_returns_attributes
+
+      def it_includes_in_headers(headers = {})
+        it 'returns the correct headers' do
+          headers.each do |header, value|
+            expect(last_response.headers[header.to_s]).to eq(eval(value))
+          end
+        end
+      end
+
+      def it_returns_resources(root:, number:)
+        it 'returns the correct number of data in the body' do
+          users = objectize_resources(last_response.body, root: root)
+          expect(users.length).to eql(number)
+        end
+      end
+      alias_method :it_returns_the_resources, :it_returns_resources
+    end
+  end
+end

data/lib/rspec/api_helpers/example_methods.rb

@@ -0,0 +1,50 @@
+require "rspec/api_helpers/version"
+
+module Rspec
+  module ApiHelpers
+    module ExampleMethods
+      def objectize_resources(json, root:)
+        array = []
+        array_hash = HashWithIndifferentAccess.new(JSON.load(json))
+
+        if root
+          array_hash = array_hash[root]
+        end
+
+        array_hash.each do |resource|
+          array << object_hash(resource)
+        end
+
+        return array
+      end
+
+      def objectize_resource(json, root:)
+        hash = HashWithIndifferentAccess.new(JSON.load(json))
+        if root
+          obj = object_hash(hash[root])
+        else
+          obj = object_hash(hash)
+        end
+
+        return obj
+      end
+
+      def object_hash(hash)
+        ObjectHash.new(hash)
+      end
+
+      class ObjectHash
+        attr_accessor :hash
+        def initialize(hash)
+          @hash = HashWithIndifferentAccess.new(hash)
+        end
+        def method_missing(name)
+          return hash[name] if hash.key? name
+          raise KeyError.new("Attribute not found in resource: #{name}")
+        end
+      end
+    end
+  end
+end
+
+

data/lib/rspec/api_helpers/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Api
+    VERSION = "0.0.1"
+  end
+end

data/lib/rspec/api_helpers.rb

@@ -0,0 +1,12 @@
+require 'rspec/api_helpers/version'
+require 'rspec/api_helpers/example_methods'
+require 'rspec/api_helpers/example_group_methods'
+
+module Rspec
+  module ApiHelpers
+    def self.included(receiver)
+      receiver.extend         ExampleGroupMethods
+      receiver.send :include, ExampleMethods
+    end
+  end
+end

data/rspec-api_helpers.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/api_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-api_helpers"
+  spec.version       = Rspec::Api::VERSION
+  spec.authors       = ["Filippos Vasilakis"]
+  spec.email         = ["vasilakisfil@gmail.com"]
+  spec.summary       = %q{Rspec matchers for APIs}
+  spec.description   = %q{Rspec matchers for APIs}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: rspec-api_helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Filippos Vasilakis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Rspec matchers for APIs
+email:
+- vasilakisfil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/api_helpers.rb
+- lib/rspec/api_helpers/example_group_methods.rb
+- lib/rspec/api_helpers/example_methods.rb
+- lib/rspec/api_helpers/version.rb
+- rspec-api_helpers.gemspec
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Rspec matchers for APIs
+test_files: []