skeleton 0.2.0 → 0.3.0

data/spec/skeleton/operation_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+require 'skeleton/operation'
+
+describe Skeleton::Operation do
+  describe '#summary=' do
+    it 'sets the summary' do
+      operation = Skeleton::Operation.new
+      operation.summary = 'foo bar'
+      assert_equal('foo bar', operation.summary)
+    end
+  end
+
+  describe '#summary?' do
+    context 'when not set' do
+      it 'returns false' do
+        operation = Skeleton::Operation.new
+        refute(operation.summary?)
+      end
+    end
+
+    context 'when set' do
+      it 'returns true' do
+        operation = Skeleton::Operation.new(summary: 'foo bar')
+        assert(operation.summary?)
+      end
+    end
+  end
+
+  describe '#consumes' do
+    context 'when not set' do
+      it 'returns an empty array' do
+        operation = Skeleton::Operation.new
+        assert_empty(operation.consumes)
+      end
+    end
+
+    context 'when set' do
+      it 'returns strings' do
+        operation = Skeleton::Operation.new({consumes: ['application/json', 'application/xml']})
+        assert_includes(operation.consumes, 'application/json')
+        assert_includes(operation.consumes, 'application/xml')
+      end
+    end
+  end
+
+  describe '#consumes?' do
+    context 'when not set' do
+      it 'returns an empty array' do
+        operation = Skeleton::Operation.new
+        refute(operation.consumes?)
+      end
+    end
+
+    context 'when set' do
+      it 'returns strings' do
+        operation = Skeleton::Operation.new({consumes: ['application/json', 'application/xml']})
+        assert(operation.consumes?)
+      end
+    end
+  end
+
+  describe '#produces' do
+    context 'when not set' do
+      it 'returns an empty array' do
+        operation = Skeleton::Operation.new
+        assert_empty(operation.produces)
+      end
+    end
+
+    context 'when set' do
+      it 'returns strings' do
+        operation = Skeleton::Operation.new({produces: ['application/json', 'application/xml']})
+        assert_includes(operation.produces, 'application/json')
+        assert_includes(operation.produces, 'application/xml')
+      end
+    end
+  end
+
+  describe '#produces?' do
+    context 'when not set' do
+      it 'returns an empty array' do
+        operation = Skeleton::Operation.new
+        refute(operation.produces?)
+      end
+    end
+
+    context 'when set' do
+      it 'returns strings' do
+        operation = Skeleton::Operation.new({produces: ['application/json', 'application/xml']})
+        assert(operation.produces?)
+      end
+    end
+  end
+
+  describe '#to_h' do
+    context 'when nothing is set' do
+      it 'returns an empty hash' do
+        operation = Skeleton::Operation.new
+        assert_empty(operation.to_h)
+      end
+    end
+
+    context 'when consumes is set' do
+      it 'returns a hash with the consumes field' do
+        operation = Skeleton::Operation.new({consumes: ['application/json', 'application/xml']})
+        hash = operation.to_h
+        refute_empty(hash, 'expected the hash to contain data')
+        assert(hash.key?(:consumes), 'expected the hash to contain :consumes')
+      end
+    end
+  end
+end

data/spec/skeleton/serializers/contact_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+require 'skeleton/contact'
+
+describe Skeleton::Contact do
+  before do
+    @contact = Skeleton::Contact.new
+  end
+
+  describe '#name=' do
+    it 'sets the name' do
+      @contact.name = 'foo'
+      assert_equal('foo', @contact.name)
+    end
+  end
+
+  describe '#email=' do
+    it 'sets the email' do
+      @contact.email = 'foo'
+      assert_equal('foo', @contact.email)
+    end
+  end
+
+  describe '#url=' do
+    it 'sets the url' do
+      @contact.url = 'foo'
+      assert_equal('foo', @contact.url)
+    end
+  end
+end

data/spec/skeleton/serializers/documentation_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+require 'skeleton/documentation'
+
+describe Skeleton::Documentation do
+  before do
+    @documentation = Skeleton::Documentation.new
+  end
+
+  describe '#description=' do
+    it 'sets the description' do
+      @documentation.description = 'foo'
+      assert_equal('foo', @documentation.description)
+    end
+  end
+
+  describe '#url=' do
+    it 'sets the url' do
+      @documentation.url = 'foo'
+      assert_equal('foo', @documentation.url)
+    end
+  end
+end

data/spec/skeleton/serializers/header_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+require 'skeleton/header'
+
+describe Skeleton::Header do
+  before do
+    @header = Skeleton::Header.new
+  end
+
+  describe '#exclusive_maximum?' do
+    describe 'when set' do
+      it 'is true' do
+        @header.exclusive_maximum = 10
+        assert(@header.exclusive_maximum?)
+      end
+    end
+
+    describe 'when not set' do
+      it 'is false' do
+        @header.exclusive_maximum = nil
+        refute(@header.exclusive_maximum?)
+      end
+    end
+  end
+
+  describe '#exclusive_minimum?' do
+    describe 'when set' do
+      it 'is true' do
+        @header.exclusive_minimum = 10
+        assert(@header.exclusive_minimum?)
+      end
+    end
+
+    describe 'when not set' do
+      it 'is false' do
+        @header.exclusive_minimum = nil
+        refute(@header.exclusive_minimum?)
+      end
+    end
+  end
+
+  describe '#unique_items?' do
+    describe 'when set' do
+      it 'is true' do
+        @header.unique_items = 10
+        assert(@header.unique_items?)
+      end
+    end
+
+    describe 'when not set' do
+      it 'is false' do
+        @header.unique_items = nil
+        refute(@header.unique_items?)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,3 +4,11 @@ require 'bundler'
 require 'minitest/autorun'
 require 'minitest/spec'
 require 'minitest/pride'
+
+module Minitest
+  class Spec
+    class << self
+      alias_method :context, :describe
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skeleton
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matthew Johnston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-30 00:00:00.000000000 Z
+date: 2014-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -81,19 +81,39 @@ files:
 - README.md
 - Rakefile
 - lib/skeleton.rb
-- lib/skeleton/action.rb
-- lib/skeleton/builder.rb
+- lib/skeleton/attributes.rb
+- lib/skeleton/config.rb
+- lib/skeleton/contact.rb
+- lib/skeleton/documentation.rb
 - lib/skeleton/example.rb
-- lib/skeleton/link.rb
+- lib/skeleton/header.rb
+- lib/skeleton/headers.rb
+- lib/skeleton/helpers/controller_helpers.rb
+- lib/skeleton/info.rb
+- lib/skeleton/item.rb
+- lib/skeleton/license.rb
+- lib/skeleton/model.rb
+- lib/skeleton/operation.rb
 - lib/skeleton/parameter.rb
+- lib/skeleton/path.rb
+- lib/skeleton/response.rb
+- lib/skeleton/responses.rb
+- lib/skeleton/schema.rb
+- lib/skeleton/scopes.rb
+- lib/skeleton/security_definitions.rb
+- lib/skeleton/security_requirement.rb
+- lib/skeleton/security_scheme.rb
+- lib/skeleton/serializers/swagger.rb
+- lib/skeleton/structure.rb
+- lib/skeleton/tag.rb
 - lib/skeleton/version.rb
 - skeleton.gemspec
-- spec/skeleton/integrated_spec.rb
+- spec/integrations/use_case_spec.rb
+- spec/skeleton/operation_spec.rb
+- spec/skeleton/serializers/contact_spec.rb
+- spec/skeleton/serializers/documentation_spec.rb
+- spec/skeleton/serializers/header_spec.rb
 - spec/spec_helper.rb
-- test/skeleton/action_test.rb
-- test/skeleton/builder_test.rb
-- test/skeleton/link_test.rb
-- test/test_helper.rb
 homepage: https://github.com/warmwaffles/skeleton
 licenses:
 - MIT
@@ -119,9 +139,10 @@ signing_key:
 specification_version: 4
 summary: Construct an api skeleton for options
 test_files:
-- spec/skeleton/integrated_spec.rb
+- spec/integrations/use_case_spec.rb
+- spec/skeleton/operation_spec.rb
+- spec/skeleton/serializers/contact_spec.rb
+- spec/skeleton/serializers/documentation_spec.rb
+- spec/skeleton/serializers/header_spec.rb
 - spec/spec_helper.rb
-- test/skeleton/action_test.rb
-- test/skeleton/builder_test.rb
-- test/skeleton/link_test.rb
-- test/test_helper.rb
+has_rdoc: 

data/lib/skeleton/action.rb

@@ -1,46 +0,0 @@
-require 'skeleton/parameter'
-require 'skeleton/example'
-require 'skeleton/link'
-
-module Skeleton
-  class Action
-    attr_accessor :description, :links, :examples, :parameters
-
-    def initialize
-      @parameters = Hash.new
-      @examples = Array.new
-      @links = Hash.new
-    end
-
-    def param(name, &block)
-      parameter = Parameter.new
-      yield(parameter) if block
-      @parameters.store(name.to_s, parameter)
-    end
-
-    def example(&block)
-      example = Example.new
-      yield(example) if block
-      @examples.push(example)
-    end
-
-    def link(args={})
-      raise(ArgumentError, ':rel is required') unless args[:rel]
-      raise(ArgumentError, ':href is required') unless args[:href]
-
-      @links.store(args[:rel], Link.new(args))
-    end
-
-    def to_h
-      hash = {
-        'description' => description,
-        'parameters' => Hash.new,
-        'links' => links.map { |_,link| link.to_h },
-        'examples' => examples.map(&:to_h)
-      }
-      parameters.each { |n, p| hash['parameters'].store(n, p.to_h) }
-      hash
-    end
-    alias_method :to_hash, :to_h
-  end
-end

data/lib/skeleton/builder.rb

@@ -1,47 +0,0 @@
-require 'multi_json'
-
-require 'skeleton/action'
-require 'skeleton/link'
-
-module Skeleton
-  class Builder
-    attr_accessor :actions
-
-    def initialize
-      @actions = Hash.new
-      @links = Hash.new
-    end
-
-    def define(verb, options={}, &block)
-      action = Action.new
-      yield(action) if block
-      @actions.store(verb.to_s.downcase, action)
-      Array(options[:also]).each { |v| define(v, &block) }
-    end
-
-    def link(args={})
-      raise(ArgumentError, ':rel is required') unless args[:rel]
-      raise(ArgumentError, ':href is required') unless args[:href]
-
-      @links.store(args[:rel], Link.new(args))
-    end
-
-    def to_h
-      hash = {
-        links: []
-      }
-      @actions.each do |verb, action|
-        hash.store(verb.to_s.upcase, action.to_h)
-      end
-      @links.each do |rel, link|
-        hash['links'] = link.to_h
-      end
-      hash
-    end
-    alias_method :to_hash, :to_h
-
-    def to_json(*)
-      MultiJson.dump(to_h)
-    end
-  end
-end

data/lib/skeleton/link.rb

@@ -1,57 +0,0 @@
-module Skeleton
-  class Link
-    attr_accessor :rel, :href, :options, :description
-    attr_accessor :templated
-
-    def initialize(args={})
-      raise(ArgumentError, ':rel is required') unless args[:rel]
-      raise(ArgumentError, ':href is required') unless args[:href]
-
-      @options = Hash.new
-      args.each do |k, v|
-        if self.respond_to?("#{k}=")
-          self.send("#{k}=", v)
-        else
-          @options[k.to_s] = v
-        end
-      end
-    end
-
-    def method_missing(m, *args, &block)
-      if @options.key?(m.to_s)
-        @options[m.to_s]
-      else
-        super
-      end
-    end
-
-    def templated?
-      !!@templated
-    end
-
-    def <=>(other)
-      @rel <=> other.rel
-    end
-
-    def eql?(other)
-      return false unless other.respond_to?(:rel)
-      @rel.eql?(other.rel)
-    end
-
-    def to_h
-      hash = Hash.new
-      hash['rel'] = @rel
-      hash['href'] = @href
-      @options.each do |k, v|
-        hash[k.to_s] = v
-      end
-      hash
-    end
-    alias_method :to_hash, :to_h
-
-    def to_s
-      opts = options.map { |k,v| '%s="%s";' % [k, v] }.join(' ')
-      '<%s>; rel="%s"; templated="%s" %s' % [href, rel, templated?, opts]
-    end
-  end
-end