kanpachi 0.0.1

data/spec/dsl/resource_spec.rb

@@ -0,0 +1,77 @@
+require_relative '../spec_helper'
+
+describe Kanpachi::DSL::Resource do
+  before do
+    Kanpachi::APIList.clear
+  end
+
+  subject do
+    Kanpachi::DSL::Resource.new(users_resource)
+  end
+
+  let(:users_resource) do
+    Kanpachi::Resource.new(:post, '/users')
+  end
+
+  it 'sets the name' do
+    subject.name 'MyAPI'
+    users_resource.name.must_equal 'MyAPI'
+  end
+
+  it 'sets the description' do
+    subject.description 'Just for testing'
+    users_resource.description.must_equal 'Just for testing'
+  end
+
+  it 'sets the priority' do
+    subject.priority 999
+    users_resource.priority.must_equal 999
+  end
+
+  it 'sets ssl' do
+    subject.ssl true
+    users_resource.ssl.must_equal true
+  end
+
+  it 'sets authentication' do
+    subject.authentication true
+    users_resource.authentication.must_equal true
+  end
+
+  it 'sets versions' do
+    subject.versions '1.0', '1.1'
+    users_resource.versions.must_include '1.0'
+    users_resource.versions.must_include '1.1'
+  end
+
+  it 'sets formats' do
+    subject.formats :xml, :json
+    users_resource.formats.must_include :xml
+    users_resource.formats.must_include :json
+  end
+
+  it 'sets the response' do
+    subject.response do
+      status 200
+    end
+    users_resource.responses.find(:default).wont_be_nil
+    users_resource.responses.find(:default).status.must_equal 200
+  end
+
+  it 'sets the response with an explicit name' do
+    subject.response :created do
+      status 201
+    end
+    users_resource.responses.find(:created).wont_be_nil
+    users_resource.responses.find(:created).status.must_equal 201
+  end
+
+  it 'sets the params' do
+    subject.params do
+      required do
+        integer :id
+      end
+    end
+    users_resource.params?.must_equal true
+  end
+end

data/spec/dsl/response_spec.rb

@@ -0,0 +1,31 @@
+require_relative '../spec_helper'
+
+describe Kanpachi::DSL::Response do
+  subject do
+    Kanpachi::DSL::Response.new(response)
+  end
+
+  let(:response) do
+    Kanpachi::Response.new(:default)
+  end
+
+  it 'sets the status' do
+    subject.status 201
+    response.status.must_equal 201
+  end
+
+  it 'sets the header' do
+    subject.header 'Content-Type', 'application/json'
+    response.headers['Content-Type'].must_equal 'application/json'
+  end
+
+  it 'sets the representation' do
+    subject.representation do
+      property :id, type: Integer
+    end
+
+    id = response.representation.properties['id']
+    id.wont_be_nil
+    id[:type].must_equal Integer
+  end
+end

data/spec/dsl/section_spec.rb

@@ -0,0 +1,49 @@
+require_relative '../spec_helper'
+
+describe Kanpachi::DSL::Section do
+  before do
+    Kanpachi::APIList.clear
+  end
+
+  subject do
+    Kanpachi::DSL::Section.new(users_section, api_dsl)
+  end
+
+  let(:api_dsl) do
+    Kanpachi::DSL::API.new(my_api)
+  end
+
+  let(:my_api) do
+    extend Kanpachi::DSL
+    api 'MyApp' do
+      title 'My App'
+    end
+  end
+
+  let(:users_section) do
+    Kanpachi::Section.new('Users')
+  end
+
+  it 'sets the description' do
+    subject.description 'Just for testing'
+    users_section.description.must_equal 'Just for testing'
+  end
+
+  it 'adds a new resource to the resource list' do
+    resource = subject.resource :get, '/posts'
+    route = [resource.http_verb, resource.url]
+    users_section.routes.must_include route
+    my_api.resources.find(*route).must_equal resource
+  end
+
+  it 'raises a Kanpachi::ResourceList::DuplicateResource if resource route already exists' do
+    subject.resource :get, '/users'
+    proc do
+      subject.resource :get, '/users' do
+        response do
+          status 400
+        end
+      end
+    end.must_raise Kanpachi::ResourceList::DuplicateResource
+  end
+end

data/spec/dsl_spec.rb

@@ -0,0 +1,46 @@
+require_relative 'spec_helper'
+
+describe Kanpachi::DSL do
+  describe 'extend self with Kanpachi::DSL' do
+    before do
+      extend Kanpachi::DSL
+      @api = api 'MyApp' do
+        title 'My App'
+      end
+      @before_api_count = Kanpachi::APIList.all.size
+    end
+
+    it 'defining an API returns that API' do
+      @api.must_be_instance_of Kanpachi::API
+    end
+
+    it 'defining a new API adds it to the APIList' do
+      your_api = api 'YourApp' do
+      end
+      Kanpachi::APIList.find('YourApp').must_equal your_api
+      Kanpachi::APIList.all.size.must_equal @before_api_count + 1
+    end
+
+    it 'defining a existing API does not add it to the APIList' do
+      same_api = api 'MyApp' do
+      end
+      Kanpachi::APIList.find('MyApp').must_equal @api
+      Kanpachi::APIList.all.size.must_equal @before_api_count
+    end
+
+    it 'defining a existing api reopens that API' do
+      same_api = api 'MyApp' do
+        title 'An App'
+      end
+      Kanpachi::APIList.find('MyApp').title.must_equal 'An App'
+    end
+  end
+
+  it '#api is only available from within self' do
+    proc do
+      api 'Test' do
+        title 'Test'
+      end
+    end.must_raise NoMethodError
+  end
+end

data/spec/error_list_spec.rb

@@ -0,0 +1,43 @@
+require_relative 'spec_helper'
+
+describe Kanpachi::ErrorList do
+  subject do
+    Kanpachi::ErrorList.new
+  end
+
+  let(:not_found_error) do
+    Kanpachi::Error.new(:not_found)
+  end
+
+  let(:populated_error_list) do
+    list = Kanpachi::ErrorList.new
+    list.add(not_found_error)
+    list
+  end
+
+  it 'initializes empty' do
+    subject.all.must_be_empty
+  end
+
+  it 'returns a hash of the internal list, with error names as the key and a Error object as the value' do
+    populated_error_list.to_hash.keys.must_include :not_found
+    populated_error_list.to_hash[:not_found].must_equal not_found_error
+  end
+
+  it 'returns an array of Error objects' do
+    populated_error_list.all.must_include not_found_error
+  end
+
+  it 'adds a error' do
+    subject.add(not_found_error)
+    subject.all.must_include not_found_error
+  end
+
+  it 'raises DuplicateError if adding an Error with a name that already exists' do
+    proc { populated_error_list.add(not_found_error) }.must_raise Kanpachi::ErrorList::DuplicateError
+  end
+
+  it 'finds a error by name' do
+    populated_error_list.find(:not_found).must_equal not_found_error
+  end
+end

data/spec/error_spec.rb

@@ -0,0 +1,34 @@
+require_relative 'spec_helper'
+
+describe Kanpachi::Error do
+  subject do
+    Kanpachi::Error.new(:not_found).tap do |e|
+      e.description = 'Error'
+      e.response = Kanpachi::Response.new(:default).tap do |r|
+        r.status = 404
+      end
+    end
+  end
+
+  it 'initialized with the name' do
+    subject.name.must_equal :not_found
+  end
+
+  it 'initialized with a Response with the name :default' do
+    subject.response.must_be_instance_of Kanpachi::Response
+    subject.response.name.must_equal :default
+  end
+
+  it 'has a description accessor' do
+    subject.description = 'Error returned with resource is not found'
+    subject.description.must_equal 'Error returned with resource is not found'
+  end
+
+  it 'has a response accessor' do
+    response = Kanpachi::Response.new(:bad_request).tap do |r|
+      r.status = 400
+    end
+    subject.response = response
+    subject.response.must_equal response
+  end
+end

data/spec/full_api_spec.rb

@@ -0,0 +1,130 @@
+require_relative 'spec_helper'
+require 'roar/representer/json'
+require 'roar/representer/feature/hypermedia'
+
+describe 'Integration Spec' do
+  it 'test the entire stack' do
+    extend Kanpachi::DSL
+
+    repo = Class.new do
+      attr_accessor :title, :id, :users
+    end
+
+    user = Class.new do
+      attr_accessor :first_name, :last_name
+    end
+
+    user_representer = Module.new do
+      include Roar::Representer::JSON
+      include Roar::Representer::Feature::Hypermedia
+      property :first_name, type: String, required: true, doc: "it's the first name"
+      property :last_name, type: String, required: true, doc: "it's the last name"
+    end
+
+    a = api 'Twitter' do
+      title 'API v1.1'
+      description 'This describes the resources that make up the official Twitter API v1.1'
+      host 'api.twitter.com'
+
+      error :malformed_params do
+        description 'Sending invalid JSON will result in a 400 Bad Request response.'
+
+        response do
+          status 400
+          header 'Content-Type', 'application/json'
+          representation do
+            property :message, type: String
+          end
+        end
+      end
+
+      section 'Tweets' do
+        description 'Tweets are the atomic building blocks of Twitter, 140-character status updates with additional associated metadata. People tweet for a variety of reasons about a multitude of topics.'
+
+        resource :get, '/user/repos' do
+          name 'list of repos'
+          versions '1.1', '2.0'
+          ssl true
+          formats :json, :xml
+
+          params do
+            required do
+              string :title, max_length: 100, nils: false, doc: "test"
+              string :gender, in: [:male, :female, :other], doc: "test"
+            end
+
+            optional do
+              integer :id, min: 0, max: 1024
+            end
+          end
+
+          response do
+            status 200
+            header 'Content-Type', 'application/json'
+            representation do
+              property :id, type: Integer, doc: "it's the id", example: 1
+              property :title, type: String, doc: "it's the title", example: 'The Title'
+              collection :users, extend: user_representer, doc: "it's the users"
+            end
+          end
+
+          response :id_list do
+            status 200
+            header 'Content-Type', 'application/json'
+            representation do
+              property :id, type: Integer, doc: "it's the id"
+            end
+          end
+        end
+      end
+    end
+
+    puts a.name
+    puts a.title
+    puts a.description
+    puts a.host
+    puts a.sections
+    puts "sections"
+    a.sections.all.each do |v|
+      puts v.name
+      puts v.description
+      puts v.routes
+    end
+
+    puts a.resources
+
+    puts "resources"
+    a.resources.to_hash.each do |k, r|
+      puts r.http_verb
+      puts r.versions.inspect
+      puts r.formats.inspect
+      puts r.name
+      puts r.authentication
+      puts r.ssl
+      puts r.description
+      puts r.params
+      puts r.responses
+      r.responses.all.first.representation.send :include, Roar::Representer::JSON
+      u = user.new
+      u.first_name = "Jack"
+      u.last_name = "Chu"
+      rep = repo.new.extend(r.responses.all.first.representation)
+      rep.title = "Hi"
+      rep.id = ""
+      rep.users = []
+      rep.users << u
+      puts rep.to_json
+
+      puts rep
+      puts r.url
+      res = r.responses.all.first
+      puts res.representation.representable_attrs.map &:inspect
+      puts res.status
+      puts res.headers
+      puts res.headers['Content-Type']
+
+      v = r.params.run(title: "woohoo", id: 1)
+      puts "valid: #{v.success?}"
+    end
+  end
+end

data/spec/markdown_spec.rb

@@ -0,0 +1,12 @@
+require_relative 'spec_helper'
+
+describe Kanpachi::Markdown do
+  subject do
+    Kanpachi::Markdown
+  end
+
+  it 'converts markdown text to html' do
+    text = '_omg_ __blah__ <http://example.org/test>'
+    subject.to_html(text).must_equal %Q{<p><em>omg</em> <strong>blah</strong> <a href=\"http://example.org/test\">http://example.org/test</a></p>\n}
+  end
+end

data/spec/resource/params_spec.rb

@@ -0,0 +1,11 @@
+require_relative '../spec_helper'
+
+describe Kanpachi::Resource::Params do
+  subject do
+    Kanpachi::Resource::Params
+  end
+
+  it 'is a kind of Mutations::Command' do
+    subject.superclass.must_equal Mutations::Command
+  end
+end

data/spec/resource_list_spec.rb

@@ -0,0 +1,53 @@
+require_relative 'spec_helper'
+
+describe Kanpachi::ResourceList do
+  subject do
+    Kanpachi::ResourceList.new
+  end
+
+  let(:login_resource) do
+    Kanpachi::Resource.new(:post, '/login').tap do |r|
+      r.name = 'login'
+    end
+  end
+
+  let(:populated_resource_list) do
+    list = Kanpachi::ResourceList.new
+    list.add(login_resource)
+    list
+  end
+
+  it 'initializes empty' do
+    subject.all.must_be_empty
+  end
+
+  it 'returns a hash of the internal list, with resource names as the key and a Resource object as the value' do
+    populated_resource_list.to_hash.keys.must_include login_resource.route
+    populated_resource_list.to_hash[login_resource.route].must_equal login_resource
+  end
+
+  it 'returns an array of Resource objects' do
+    populated_resource_list.all.must_include login_resource
+  end
+
+  it 'adds a resource' do
+    subject.add(login_resource)
+    subject.all.must_include login_resource
+  end
+
+  it 'raises DuplicateResource if adding an Resource with a name that already exists' do
+    proc { populated_resource_list.add(login_resource) }.must_raise Kanpachi::ResourceList::DuplicateResource
+  end
+
+  it 'finds a resource by http verb and url' do
+    populated_resource_list.find(:post, '/login').must_equal login_resource
+  end
+
+  it 'finds a resource by name' do
+    populated_resource_list.named('login').must_equal login_resource
+  end
+
+  it 'raises UnknownResource if resource not found by name' do
+    proc { populated_resource_list.named('logout') }.must_raise Kanpachi::ResourceList::UnknownResource
+  end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,144 @@
+require_relative 'spec_helper'
+
+describe Kanpachi::Resource do
+  describe 'initialized resource' do
+    subject do
+      Kanpachi::Resource.new(:get, '/test-me')
+    end
+
+    let(:params) do
+      Class.new(Kanpachi::Resource::Params) do
+        required do
+          integer :id
+        end
+
+        optional do
+          string :name
+        end
+      end
+    end
+
+    let(:required_params) do
+      Class.new(Kanpachi::Resource::Params) do
+        required do
+          integer :id
+        end
+      end
+    end
+
+    let(:optional_params) do
+      Class.new(Kanpachi::Resource::Params) do
+        optional do
+          string :id
+        end
+      end
+    end
+
+    it 'returns the http verb' do
+      subject.http_verb.must_equal :get
+    end
+
+    it 'returns the url' do
+      subject.url.must_equal '/test-me'
+    end
+
+    it 'returns the params' do
+      subject.params = params
+      subject.params.ancestors.must_include Kanpachi::Resource::Params
+    end
+
+    it 'returns the response list' do
+      responses = subject.responses
+      responses.must_be_instance_of Kanpachi::ResponseList
+      responses.all.must_be_empty
+    end
+
+    it 'initializes formats as an empty set' do
+      subject.formats.must_equal Set.new
+    end
+
+    it 'initializes versions as an empty set' do
+      subject.versions.must_equal Set.new
+    end
+
+    it 'initializes priority to 50' do
+      subject.priority.must_equal 50
+    end
+
+    it 'initializes ssl to false' do
+      subject.ssl.must_equal false
+    end
+
+    it 'initializes authentication to false' do
+      subject.authentication.must_equal false
+    end
+
+    it 'has a description accessor' do
+      subject.description = 'This resource tests me.'
+      subject.description.must_equal 'This resource tests me.'
+    end
+
+    it 'has a name accessor' do
+      subject.name = :test_me
+      subject.name.must_equal :test_me
+    end
+
+    it 'has a priority accessor' do
+      subject.priority = 100
+      subject.priority.must_equal 100
+    end
+
+    it 'has a ssl accessor' do
+      subject.ssl = true
+      subject.ssl.must_equal true
+    end
+
+    it 'has an authentication accessor' do
+      subject.authentication = true
+      subject.authentication.must_equal true
+    end
+
+    it 'has a versions accessor' do
+      subject.versions << '1.1'
+      subject.versions.must_include '1.1'
+    end
+
+    it 'has a formats accessor' do
+      subject.formats << :xml
+      subject.formats.must_include :xml
+    end
+
+    it 'has a params accessor' do
+      subject.params = params
+      subject.params.must_equal params
+    end
+
+    it 'returns true if the resource has defined any params' do
+      subject.params?.must_equal false
+      subject.params = required_params
+      subject.params?.must_equal true
+      subject.params = optional_params
+      subject.params?.must_equal true
+    end
+
+    it 'returns the route' do
+      subject.route.must_equal 'GET /test-me'
+    end
+
+    it 'sorts based on priority' do
+      middle = subject
+      lower = Kanpachi::Resource.new(:get, '/lower')
+      lower.priority = -100
+      higher = Kanpachi::Resource.new(:get, '/lower')
+      higher.priority = 100
+      [middle, lower, higher].sort.must_equal [lower, middle, higher]
+    end
+  end
+
+  it 'ensures the url is prefixed with a slash' do
+    resource = Kanpachi::Resource.new(:get, '/has-slash')
+    resource.url.must_equal '/has-slash'
+    resource = Kanpachi::Resource.new(:get, 'missing-slash')
+    resource.url.must_equal '/missing-slash'
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,57 @@
+require_relative 'spec_helper'
+
+describe Kanpachi::Response do
+  subject do
+    Kanpachi::Response.new(:default)
+  end
+
+  it 'initializes with the status' do
+    subject.status.must_equal 200
+  end
+
+  it 'initializes with a headers hash' do
+    subject.headers.must_equal Hash.new
+  end
+
+  it 'returns headers' do
+    subject.headers['Content-Type'] = 'application/json'
+    subject.headers.keys.must_include 'Content-Type'
+  end
+
+  it 'has a representation accessor' do
+    representation = Module.new do
+      include Kanpachi::Response::Representation
+      property :title
+    end
+    subject.representation = representation
+    subject.representation.must_equal representation
+  end
+
+  it 'representation is a Roar representer' do
+    subject.representation.ancestors.must_include Roar::Representer
+    subject.representation.ancestors.must_include Roar::Representer::Feature::Hypermedia
+  end
+
+  it 'representation returns properties' do
+    user_representer = Module.new do
+      include Kanpachi::Response::Representation
+      property :name, type: String
+      property :email, type: String
+    end
+
+    representation = Module.new do
+      include Kanpachi::Response::Representation
+      property :id, type: Integer
+      collection :people, extend: user_representer
+      hash :user, extend: user_representer
+    end
+    representation.properties.keys.must_include 'id'
+    representation.properties.keys.must_include 'people'
+    representation.properties.keys.must_include 'user'
+    representation.properties['id'][:type].must_equal Integer
+    representation.properties['people'][:collection].must_equal true
+    representation.properties['people'][:default].must_be_empty
+    representation.properties['people']['name'][:type].must_equal String
+    representation.properties['people']['email'][:type].must_equal String
+  end
+end