rspec_api_helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6d608d1fed495e82a37954164f31ac9b4b5eb36
+  data.tar.gz: eddba7eda1887a1d18465803783253e5d931806c
+SHA512:
+  metadata.gz: e34e272f700e891486e4648b068e662ba8ca220a240c5912f765802dca1096460b84e501fa7aae97839d111b64ccf4a1c894e97021c7e1660463b98570a46105
+  data.tar.gz: d653994bbad3645ff0becb1f118a4912e0106d7a5459db55ece71e175c98f0d962646aa3ca1306f91bdc09659b2faac0b67fc091e0014c38cbf0f09525e57589

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+before_install:
+    - gem update --system
+install: 'bundle install'
+script: 'bundle exec rspec --format documentation'
+rvm:
+  - '2.1.4'
+  - '2.0.0'
+  - '1.9.3'
+  - jruby-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ian Ker-Seymer
+
+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,74 @@
+RspecApiHelpers
+===============
+[![Build Status](https://travis-ci.org/sweatshirtio/rspec_api_helpers.svg?branch=master)](https://travis-ci.org/sweatshirtio/rspec_api_helpers)
+
+This is a Gem to help you with all of you Rails API testing woes. The goal is
+to provide functionality to make testing APIs a breeze. I hope you like it!
+
+Add this to your Gemfile:
+
+    gem 'rspec_api_helpers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec_api_helpers
+
+Include it in your spec_helper
+
+```ruby
+RSpec.configure do |config|
+  # ...
+  config.include RspecApiHelpers
+  # ...
+end
+```
+
+## Usage
+
+1. Built it strategy for coercing FactoryGirl factories into json:
+
+```ruby
+FactoryGirl.json :user, name: 'Mrs. Mock', email: 'test@test.com'
+# => {\"name\":\"Mrs. Mock\",\"email\":\"test@test.com\"}"
+```
+
+2. Ready-to-fire headers:
+
+```ruby
+headers_for :json
+# => { 'CONTENT_TYPE' => 'application/json', 'ACCEPT' => 'application/json' }
+```
+
+3. Automatic JSON parsing for `response.body`:
+
+```ruby
+# Call this in your spec
+response_body
+```
+
+4. Hash with indifferent access by default when parsing JSON:
+
+```ruby
+parse_json response.body
+# => can now use user[:email], etc.
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec_api_helpers'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/sweatshirtio/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.rb

@@ -0,0 +1,17 @@
+require 'rspec_api_helpers/version'
+require 'rspec_api_helpers/headers'
+require 'rspec_api_helpers/json'
+require 'rspec_api_helpers/strategies/json_strategy'
+
+require 'active_support/core_ext/object/json'
+require 'active_support/core_ext/hash'
+
+module RspecApiHelpers
+  def self.included(base)
+    constants.map(&method(:const_get)).each do |const|
+      base.include const if const.class == Module
+    end
+  end
+end
+
+FactoryGirl.register_strategy :json, RspecApiHelpers::Strategies::JsonStrategy

data/lib/rspec_api_helpers/headers.rb

@@ -0,0 +1,16 @@
+module RspecApiHelpers
+  module Headers
+    def headers_for(type)
+      _headers.send type
+    end
+
+    def _headers
+      headers = OpenStruct.new
+      headers.json = {
+        'CONTENT_TYPE' => 'application/json',
+        'ACCEPT' => 'application/json'
+      }
+      headers
+    end
+  end
+end

data/lib/rspec_api_helpers/json.rb

@@ -0,0 +1,11 @@
+module RspecApiHelpers
+  module Json
+    def response_body
+      @response_body ||= parse_json response.body
+    end
+
+    def parse_json(json)
+      ActiveSupport::HashWithIndifferentAccess.new(ActiveSupport::JSON.decode json)
+    end
+  end
+end

data/lib/rspec_api_helpers/strategies/json_strategy.rb

@@ -0,0 +1,17 @@
+require 'factory_girl'
+
+module RspecApiHelpers
+  module Strategies
+    class JsonStrategy
+      def initialize
+        @strategy = FactoryGirl.strategy_by_name(:build).new
+      end
+
+      delegate :association, to: :@strategy
+
+      def result(evaluation)
+        @strategy.result(evaluation).to_json
+      end
+    end
+  end
+end

data/lib/rspec_api_helpers/version.rb

@@ -0,0 +1,3 @@
+module RspecApiHelpers
+  VERSION = '0.1.0'
+end

data/rspec_api_helpers.gemspec

@@ -0,0 +1,27 @@
+# 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       = RspecApiHelpers::VERSION
+  spec.authors       = ["Ian Ker-Seymer"]
+  spec.email         = ["i.kerseymer@gmail.com"]
+  spec.summary       = %q{Helpers for testing Rails APIs.}
+  spec.homepage      = "https://github.com/ianks/rspec_api_helpers"
+  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_dependency "activesupport", "~> 4.0"
+  spec.add_dependency "factory_girl", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "pry"
+end

data/spec/headers_spec.rb

@@ -0,0 +1,17 @@
+describe RspecApiHelpers::Headers do
+  describe '.headers_for' do
+    describe :json do
+      subject { headers_for :json}
+
+      it {is_expected.to be_a Hash }
+
+      it 'should return CONTENT_TYPE' do
+        expect(subject['CONTENT_TYPE']).to eq 'application/json'
+      end
+
+      it 'should return ACCEPT' do
+        expect(subject['ACCEPT']).to eq 'application/json'
+      end
+    end
+  end
+end

data/spec/json_spec.rb

@@ -0,0 +1,40 @@
+describe RspecApiHelpers::Json do
+  let(:data) do
+    <<-json
+      {
+        "data" : "is good",
+        "email" : "test@test.com",
+        "location" : {
+          "city" : "Somewhere",
+          "state" : "Cool"
+        }
+      }
+    json
+  end
+
+  let(:response) { Class.new }
+
+  subject { parse_json data }
+
+  describe '.parse_json' do
+    it 'should have indifferent access' do
+      expect(subject[:email]).to eq 'test@test.com'
+    end
+
+    it 'should have indifferent access (nested)' do
+      expect(subject[:location][:city]).to eq 'Somewhere'
+    end
+  end
+
+  describe '.response_body' do
+    before { allow(response).to receive(:body) { data } }
+
+    it 'should return a hash' do
+      expect(response_body).to be_a Hash
+    end
+
+    it 'return correct data' do
+      expect(response_body[:email]).to eq 'test@test.com'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rspec_api_helpers'
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.warnings = true
+  config.default_formatter = 'doc' if config.files_to_run.one?
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.include RspecApiHelpers::Json
+  config.include RspecApiHelpers::Headers
+end

data/spec/strategies_spec.rb

@@ -0,0 +1,18 @@
+describe RspecApiHelpers::Strategies::JsonStrategy do
+  before do
+    User = Class.new { attr_accessor :name, :email }
+
+    FactoryGirl.define do
+      factory :user do
+        email 'test@test.com'
+        name 'Mrs. Mock'
+      end
+    end
+  end
+
+  subject { FactoryGirl.json :user }
+
+  it 'should render user as json' do
+    expect(subject).to eq '{"email":"test@test.com","name":"Mrs. Mock"}'
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: rspec_api_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian Ker-Seymer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
+email:
+- i.kerseymer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec_api_helpers.rb
+- lib/rspec_api_helpers/headers.rb
+- lib/rspec_api_helpers/json.rb
+- lib/rspec_api_helpers/strategies/json_strategy.rb
+- lib/rspec_api_helpers/version.rb
+- rspec_api_helpers.gemspec
+- spec/headers_spec.rb
+- spec/json_spec.rb
+- spec/spec_helper.rb
+- spec/strategies_spec.rb
+homepage: https://github.com/ianks/rspec_api_helpers
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Helpers for testing Rails APIs.
+test_files:
+- spec/headers_spec.rb
+- spec/json_spec.rb
+- spec/spec_helper.rb
+- spec/strategies_spec.rb
+has_rdoc: