zoanthid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 930c8d9fb4cb927d63b4a29d758992959234d184
+  data.tar.gz: 5ed5369376a391e3df10264fc37ae626478edac1
+SHA512:
+  metadata.gz: 29d1c07769c54b6f6a12f86ba4c28139062b69e0ba04e58854eab98b8a13e76ffbf3b61dbf77e0fafbc222cbdac1942bb3ee2f313ffd55494bd1573643ce92ff
+  data.tar.gz: 1044ba511f4498f9acff5ca41f43ff41671857348baf7331ef1cde235c5e0f44bfc8002593b78be70725a8eb84fcf1765cd7ca4ec546d179958034ed7a7751ab

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/CHANGES.md

@@ -0,0 +1,5 @@
+# Changes
+
+## 0.1.0
+
+* Initial run at an API.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ben Hamill
+
+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,66 @@
+# Zoanthid [![Build Status](https://travis-ci.org/benhamill/zoanthid.png)](https://travis-ci.org/benhamill/zoanthid) [![Code Climate](https://codeclimate.com/github/benhamill/zoanthid.png)](https://codeclimate.com/github/benhamill/zoanthid)
+
+Zoanthids are [a kind of coral](http://en.wikipedia.org/wiki/Zoantharia) that is
+very robust.
+
+Zoanthid is a library that interfaces with Rails and RSpec to help you write
+expressive tests for your [HAL](http://stateless.co/hal_specification.html) API.
+It uses [Cetacean](https://github.com/benhamill/cetacean#readme) and
+[Faraday](https://github.com/lostisland/faraday#readme) to make the requests and
+deal with the responses. It's not configurable at this juncture.
+
+## Usage
+
+This will most likely change, but here's the idea so far:
+
+Require Zoanthid in your spec_helper.rb, then if you put spec files in
+`spec/api/`, or label them with `type: :api` and you'll get some helpers.
+
+``` ruby
+describe "listing posts" do
+  before do
+    get :root
+    get expand_uri(:posts)
+  end
+
+  it "shows the total" do
+    expect(document['total']).to eq(25)
+  end
+
+  it "has a next link" do
+    expect(expand_uri(:next)).to eq('/posts?page=2')
+  end
+
+  it "can jump to any page" do
+    expect(expand_uri(:jump_to_page, page: 99)).to eq('/posts?page=99')
+  end
+
+  it "embeds the posts" do
+    expect(document.embedded(:posts).count).to eq(25)
+  end
+end
+```
+
+## The Future?
+
+Possibly in the future, there might be nice matchers. I plan to add features
+slowly, though, only in the face of an actual need.
+
+## Contributing
+
+Help is gladly welcomed. If you have a feature you'd like to add, it's much more
+likely to get in (or get in faster) the closer you stick to these steps:
+
+1. Open an Issue to talk about it. We can discuss whether it's the right
+  direction or maybe help track down a bug, etc.
+1. Fork the project, and make a branch to work on your feature/fix. Master is
+  where you'll want to start from.
+1. Turn the Issue into a Pull Request. There are several ways to do this, but
+  [hub](https://github.com/defunkt/hub) is probably the easiest.
+1. Make sure your Pull Request includes tests.
+1. Bonus points if your Pull Request updates `CHANGES.md` to include a summary
+   of your changes and your name like the other entries. If the last entry is
+   the last release, add a new `## Unreleased` heading at the top.
+
+If you don't know how to fix something, even just a Pull Request that includes a
+failing test can be helpful. If in doubt, make an Issue to discuss.

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/api_spec.rb

@@ -0,0 +1,52 @@
+module HALSpec
+  module DSL
+    def app
+      ::Rails.application
+    end
+
+    def client
+      @client ||= Faraday.new do |client|
+        client.adapter :rack, app
+        client.headers['Accept'] = 'application/hal+json'
+      end
+    end
+
+    %w(get post put delete head patch).each do |verb|
+      define_method verb do |*args, &block|
+        Cetacean.new(client.send verb, *args, &block)
+      end
+    end
+  end
+
+  module ExampleGroup
+    extend ActiveSupport::Concern
+
+    DEFAULT_HOST = "www.example.com"
+
+    included do
+      metadata[:type] = :hal
+
+      app = ::Rails.application
+      if app.respond_to?(:routes)
+        include app.routes.url_helpers     if app.routes.respond_to?(:url_helpers)
+        include app.routes.mounted_helpers if app.routes.respond_to?(:mounted_helpers)
+
+        if respond_to?(:default_url_options)
+          default_url_options[:host] ||= ::HALSpec::ExampleGroup::DEFAULT_HOST
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(
+    HALSpec::ExampleGroup,
+    type: :hal,
+    example_group: ->(example_group, metadata) do
+      metadata[:type].nil? && config.escaped_path(%w[spec hal]) =~ example_group[:file_path]
+    end
+  )
+
+  config.include HALSpec::DSL, type: :hal
+end

data/lib/zoanthid.rb

@@ -0,0 +1,14 @@
+require "zoanthid/version"
+require "zoanthid/browser"
+require "zoanthid/dsl"
+require "zoanthid/example_group"
+
+module Zoanthid
+  def self.app
+    @app
+  end
+
+  def self.app=(app)
+    @app = app
+  end
+end

data/lib/zoanthid/browser.rb

@@ -0,0 +1,34 @@
+class Zoanthid::Browser
+  REQUEST_METHODS = [:get, :post, :put, :delete, :head, :patch]
+
+  def document
+    history.last
+  end
+
+  def clear_history!
+    @history = []
+  end
+
+  REQUEST_METHODS.each do |verb|
+    define_method verb do |*args, &block|
+      history << Cetacean.new(client.send verb, *args, &block)
+    end
+  end
+
+  private
+
+  def app
+    Zoanthid.app
+  end
+
+  def client
+    @client ||= Faraday.new do |client|
+      client.adapter :rack, app
+      client.headers['Accept'] = 'application/hal+json'
+    end
+  end
+
+  def history
+    @history ||= []
+  end
+end

data/lib/zoanthid/dsl.rb

@@ -0,0 +1,28 @@
+require 'cetacean'
+require 'faraday'
+
+module Zoanthid::DSL
+  def document
+    browser.document
+  end
+
+  def browser
+    @browser ||= Zoanthid::Browser.new
+  end
+
+  def expand_link(rel, expansions={})
+    document.get_uri(rel).expand(expansions)
+  end
+
+  def clear_history!
+    browser.clear_history!
+  end
+
+  Zoanthid::Browser::REQUEST_METHODS.each do |verb|
+    define_method verb do |*args, &block|
+      args[0] = '/' if args.first == :root
+
+      browser.send verb, *args, &block
+    end
+  end
+end

data/lib/zoanthid/example_group.rb

@@ -0,0 +1,13 @@
+module Zoanthid
+  module ExampleGroup
+    DEFAULT_HOST = "www.example.com"
+
+    def included(base)
+      metadata[:type] = :api
+
+      if respond_to?(:default_url_options)
+        default_url_options[:host] ||= Zoanthid::ExampleGroup::DEFAULT_HOST
+      end
+    end
+  end
+end

data/lib/zoanthid/rspec.rb

@@ -0,0 +1,20 @@
+require 'zoanthid'
+require 'rspec/core'
+
+RSpec.configure do |config|
+  config.include(
+    Zoanthid::ExampleGroup,
+    type: :api,
+    example_group: ->(example_group, metadata) do
+      metadata[:type].nil? && config.escaped_path(%w[spec api]) =~ example_group[:file_path]
+    end
+  )
+
+  config.include Zoanthid::DSL, type: :api
+
+  config.after do
+    if self.class.include?(Zoanthid::DSL)
+      clear_history!
+    end
+  end
+end

data/lib/zoanthid/version.rb

@@ -0,0 +1,3 @@
+module Zoanthid
+  VERSION = "0.1.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require_relative 'support/test_app'
+require 'zoanthid/rspec'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = 'random'
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
+end
+
+require 'pry'

data/spec/support/test_app.rb

@@ -0,0 +1,35 @@
+require 'sinatra/base'
+require 'json'
+
+class TestApp < Sinatra::Base
+  configure do
+    mime_type :hal, 'application/hal+json'
+  end
+
+  before do
+    content_type :hal
+  end
+
+  after do
+    if content_type == 'application/hal+json'
+      body JSON.dump(body)
+    end
+  end
+
+  get '/' do
+    {
+      _links: {
+        self: { href: '/' },
+        posts: { href: '/posts{?page}', templated: true }
+      },
+      get_root: 'get root'
+    }
+  end
+
+  get '/posts' do
+    {
+      _links: { self: { href: '/posts' } },
+      posts: 'posts'
+    }
+  end
+end

data/spec/zoanthid_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'zoanthid'
+
+describe Zoanthid, type: 'api' do
+  before do
+    Zoanthid.app = TestApp
+
+    get :root
+  end
+
+  it "handles GETs" do
+    expect(document['get_root']).to eq('get root')
+  end
+
+  it "can extract URIs" do
+    expect(expand_link(:posts)).to eq('/posts')
+  end
+
+  it "can expand URIs" do
+    expect(expand_link(:posts, page: 2)).to eq('/posts?page=2')
+  end
+
+  context "following a rel" do
+    before do
+      get expand_link(:posts)
+    end
+
+    it "ends up on the right document" do
+      expect(document['posts']).to eq('posts')
+    end
+  end
+
+  context "in a different context" do
+    it "forgets the document from another context" do
+      expect(document['get_root']).to eq('get root')
+    end
+  end
+end

data/zoanthid.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zoanthid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zoanthid"
+  spec.version       = Zoanthid::VERSION
+  spec.authors       = ["Ben Hamill"]
+  spec.email         = ["git-commits@benhamill.com"]
+  spec.description   = %q{Zoanthid is a library that interfaces with Rails and RSpec to help you write expressive tests for your HAL API.}
+  spec.summary       = %q{Kinda like Capybara for your HAL APIs.}
+  spec.homepage      = "https://github.com/benhamill/zoanthid#readme"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "sinatra"
+
+  spec.add_dependency "cetacean", "~> 1.0"
+  spec.add_dependency "rack-test", "~> 0.6.2"
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: zoanthid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Hamill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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'
+- !ruby/object:Gem::Dependency
+  name: cetacean
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+description: Zoanthid is a library that interfaces with Rails and RSpec to help you
+  write expressive tests for your HAL API.
+email:
+- git-commits@benhamill.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGES.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/api_spec.rb
+- lib/zoanthid.rb
+- lib/zoanthid/browser.rb
+- lib/zoanthid/dsl.rb
+- lib/zoanthid/example_group.rb
+- lib/zoanthid/rspec.rb
+- lib/zoanthid/version.rb
+- spec/spec_helper.rb
+- spec/support/test_app.rb
+- spec/zoanthid_spec.rb
+- zoanthid.gemspec
+homepage: https://github.com/benhamill/zoanthid#readme
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Kinda like Capybara for your HAL APIs.
+test_files:
+- spec/spec_helper.rb
+- spec/support/test_app.rb
+- spec/zoanthid_spec.rb