skeleton 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1b90b70d2ffd87c025cfd71b1de006d2c8b2eb7
+  data.tar.gz: 40574952c4de7e2919e5b3593ea984e9e459b707
+SHA512:
+  metadata.gz: b4b5754b13d7b116feb66afd02576adb07b6510059e50ed2d5c7ae7b245d44313ae5972e22342fe3d9124c13b5b5e163c0ccbb5dfd9d3c0c3215ce2d03710083
+  data.tar.gz: 464593a435ca7e9e6724cdb60e24bc85247c36fd71ded9d3de4ae0d946e893460796b86ec520fd45298ce10a0c87b387d32baecb0918d7ecce4e9e8f9af0fc4e

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+skeleton

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matthew Johnston
+
+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,106 @@
+# Skeleton
+
+Skeleton is a tool to help people construct `OPTIONS` api responses. This
+library is simply a data structure with no ties to any single framework.
+
+## Example
+
+```ruby
+require 'skeleton'
+
+skeleton = Skeleton.build do |config|
+  config.define(:get, also: :head) do |action|
+    action.description = 'Display a list of resources'
+
+    action.param('limit') do |p|
+      p.type = 'integer'
+      p.description = 'The number of items desired'
+      p.required = false
+      p.restriction('Minimum value is 0')
+      p.restriction('Maximum value is 9000')
+    end
+
+    action.param('offset') do |p|
+      p.type = 'integer'
+      p.description = 'The offset within the collection'
+      p.required = false
+      p.restriction('Minimum value is 0')
+    end
+
+    action.example do |e|
+      e.param('limit', 10),
+      e.param('offset', 0)
+    end
+
+    action.link(name: 'Self', rel: 'self', href: 'https://api.example.org/resources')
+  end
+
+  config.link(name: 'Documentation', rel: 'docs', href: 'https://docs.example.org/resources')
+end
+
+skeleton.to_h
+```
+
+Example `Skeleton::Builder#to_h` call
+
+```ruby
+{
+  "links"=>[],
+  "GET"=>{
+    "description"=>"Display a list of resources",
+    "parameters"=>{
+      "limit"=>{
+        "type"=>"integer",
+        "description"=>"The number of items desired",
+        "required"=>false,
+        "allowed"=>[],
+        "restrictions"=>[
+          "Minimum value is 0",
+          "Maximum value is 9000"
+        ]
+      },
+      "offset"=>{
+        "type"=>"integer",
+        "description"=>"The offset within the collection",
+        "required"=>false,
+        "allowed"=>[],
+        "restrictions"=>[
+          "Minimum value is 0"
+        ]
+      }
+    },
+    "links"=>[
+      {
+        "name"=>"Self",
+        "rel"=>"self",
+        "href"=>"https://api.example.org/resources"
+      }
+    ],
+    "examples"=>[
+      {
+        "limit"=>10,
+        "offset"=>0
+      }
+    ]
+  }
+}
+```
+
+## Testing
+
+We are using MiniTest in order to write tests. Please follow this guideline:
+
+  * If the test is not a unit test, it belongs under `spec`
+  * If the test is a unit test, it belongs under `test`
+  * Test to the best you can
+
+```sh
+rake test
+```
+
+## Contributing
+
+  * Fork this repo
+  * Do work on a separate branch
+  * Submit a pull request
+  * Drink a beer

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler/gem_tasks'
+
+namespace :test do
+  task :env do
+    $LOAD_PATH.unshift('lib', 'spec', 'test')
+  end
+
+  desc 'Runs only the units in this project'
+  task :units => [:env] do
+    Dir.glob('./test/**/*_test.rb') { |f| require f }
+  end
+
+  desc 'Runs only the specs in this project'
+  task :specs => [:env] do
+    Dir.glob('./spec/**/*_spec.rb') { |f| require f }
+  end
+
+  desc 'Runs all of the tests within this project'
+  task :all => [:units, :specs]
+end
+
+desc 'Runs all of the tests within this project'
+task :test => 'test:all'
+task :default => :test

data/lib/skeleton.rb

@@ -0,0 +1,10 @@
+require 'skeleton/version'
+require 'skeleton/builder'
+
+module Skeleton
+  def self.build(&block)
+    builder = Builder.new
+    yield(builder) if block
+    builder
+  end
+end

data/lib/skeleton/action.rb

@@ -0,0 +1,46 @@
+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

@@ -0,0 +1,41 @@
+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
+  end
+end

data/lib/skeleton/example.rb

@@ -0,0 +1,17 @@
+module Skeleton
+  class Example
+    def initialize
+      @params = {}
+    end
+
+    def param(key, value)
+      p = key.to_s.downcase
+      @params[p] = value
+    end
+
+    def to_h
+      @params
+    end
+    alias_method :to_hash, :to_h
+  end
+end

data/lib/skeleton/link.rb

@@ -0,0 +1,57 @@
+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

data/lib/skeleton/parameter.rb

@@ -0,0 +1,32 @@
+module Skeleton
+  class Parameter
+    attr_accessor :type, :description, :required, :allowed, :default, :restrictions
+
+    def initialize(args={})
+      @required = false
+      @allowed = []
+      @restrictions = []
+
+      args.each do |k, v|
+        self.send("#{k}=", v) if self.respond_to?("#{k}=")
+      end
+    end
+
+    def restriction(desc)
+      @restrictions.push(desc)
+    end
+
+    def to_h
+      hash = {
+        'type' => type,
+        'description' => description,
+        'required' => required
+      }
+      hash['default'] = default if default
+      hash['allowed'] = allowed if allowed
+      hash['restrictions'] = restrictions unless restrictions.empty?
+      hash
+    end
+    alias_method :to_hash, :to_h
+  end
+end

data/lib/skeleton/version.rb

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

data/skeleton.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'skeleton/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'skeleton'
+  spec.version       = Skeleton::VERSION
+  spec.authors       = ['Matthew Johnston']
+  spec.email         = ['warmwaffles@gmail.com']
+  spec.summary       = %q{Construct an api skeleton for options}
+  spec.description   = %q{Construct an api skeleton for options}
+  spec.homepage      = 'https://github.com/warmwaffles/skeleton'
+  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('multi_json')
+
+  spec.add_development_dependency('bundler', '~> 1.6')
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('minitest')
+end

data/spec/skeleton/integrated_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+require 'skeleton'
+
+describe 'Full integration test' do
+  it 'when describing collection resource' do
+    skeleton = Skeleton.build do |config|
+      config.define(:get, also: :head) do |action|
+        action.description = 'Display a list of resources'
+
+        action.param('limit') do |p|
+          p.type = 'integer'
+          p.description = 'The number of items desired'
+          p.required = false
+          p.restriction('Minimum value is 0')
+          p.restriction('Maximum value is 9000')
+        end
+
+        action.param('offset') do |p|
+          p.type = 'integer'
+          p.description = 'The offset within the collection'
+          p.required = false
+          p.restriction('Minimum value is 0')
+        end
+
+        action.example do |e|
+          e.param('limit', 10)
+          e.param('offset', 0)
+        end
+        action.link(name: 'Self', rel: 'self', href: 'https://api.example.org/resources')
+      end
+      config.link(name: 'Documentation', rel: 'docs', href: 'https://docs.example.org/resources')
+    end
+
+    refute_nil(skeleton.actions['get'])
+    refute_nil(skeleton.actions['head'])
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler'
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/pride'

data/test/skeleton/action_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+
+require 'skeleton/action'
+
+module Skeleton
+  class ActionTest < Minitest::Test
+    def setup
+      @action = Action.new
+    end
+
+    def test_param
+      @action.param(:foo) do |param|
+        param.type = 'integer'
+        param.required = true
+      end
+      refute_nil(@action.parameters['foo'], 'expected parameters to contain "foo"')
+      parameter = @action.parameters['foo']
+      assert_equal('integer', parameter.type)
+      assert(parameter.required, 'expected the parameter to be required')
+
+      @action.param('bar[nested]') do |param|
+        param.type = 'string'
+        param.required = false
+      end
+      refute_nil(@action.parameters['bar[nested]'], 'expected parameters to contain "bar[nested]"')
+      parameter = @action.parameters['bar[nested]']
+      assert_equal('string', parameter.type)
+      refute(parameter.required, 'expected the parameter to not be required')
+    end
+
+    def test_link
+      assert_raises(ArgumentError) do
+        @action.link({})
+      end
+
+      assert_raises(ArgumentError) do
+        @action.link(name: 'Self', href: 'http://example.org/resource/{id}', templated: true)
+      end
+
+      assert_raises(ArgumentError) do
+        @action.link(name: 'Self', rel: 'self', templated: true)
+      end
+
+      @action.link(name: 'Self', rel: 'self', href: 'http://example.org/resource/{id}', templated: true)
+      refute_nil(@action.links['self'])
+      @action.link(name: 'Root', rel: 'root', href: 'http://example.org/')
+      refute_nil(@action.links['root'])
+    end
+
+    def test_example
+      assert_empty(@action.examples)
+      @action.example do |e|
+        e.param('some[val]', '123')
+      end
+      assert_equal(1, @action.examples.count)
+      @action.example do |e|
+        e.param('some[val]', '123')
+      end
+      assert_equal(2, @action.examples.count)
+    end
+
+    def test_to_h
+      @action.description = 'test'
+      @action.param(:foo) do |param|
+        param.type = 'integer'
+        param.required = true
+        param.allowed = [12]
+      end
+
+      hash = @action.to_h
+
+      assert_equal('test', hash['description'])
+      refute_nil(hash['links'])
+      refute_nil(hash['examples'])
+      refute_nil(hash['parameters'])
+    end
+  end
+end

data/test/skeleton/builder_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+require 'skeleton/builder'
+
+module Skeleton
+  class BuilderTest < Minitest::Test
+    def setup
+      @builder = Builder.new
+    end
+
+    def test_define_single
+      @builder.define('get') do |action|
+        action.description = 'something'
+      end
+      refute_nil(@builder.actions['get'])
+      assert_equal('something', @builder.actions['get'].description)
+    end
+
+    def test_define_extra
+      @builder.define('get', also: 'post') do |action|
+        action.description = 'something'
+      end
+      refute_nil(@builder.actions['get'])
+      refute_nil(@builder.actions['post'])
+      assert_equal('something', @builder.actions['get'].description)
+      assert_equal('something', @builder.actions['post'].description)
+    end
+
+    def test_define_array
+      @builder.define('get', also: ['post']) do |action|
+        action.description = 'something'
+      end
+      refute_nil(@builder.actions['get'])
+      refute_nil(@builder.actions['post'])
+      assert_equal('something', @builder.actions['get'].description)
+      assert_equal('something', @builder.actions['post'].description)
+    end
+
+    def test_define_multiple
+      @builder.define('get', also: ['post', 'head']) do |action|
+        action.description = 'something'
+      end
+      refute_nil(@builder.actions['get'])
+      refute_nil(@builder.actions['post'])
+      refute_nil(@builder.actions['head'])
+      assert_equal('something', @builder.actions['get'].description)
+      assert_equal('something', @builder.actions['post'].description)
+      assert_equal('something', @builder.actions['head'].description)
+    end
+  end
+end

data/test/skeleton/link_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+require 'skeleton/link'
+
+module Skeleton
+  class LinkTest < Minitest::Test
+    def setup
+      @link = Link.new(rel: 'self', name: 'Self', href: 'http://example.org')
+    end
+
+    def test_initialize
+      assert_raises(ArgumentError) do
+        Link.new
+      end
+      assert_raises(ArgumentError) do
+        Link.new(rel: 'self')
+      end
+
+      Link.new(rel: 'self', href: 'http://example.org')
+    end
+
+    def test_method_missing
+      assert_raises(NoMethodError) do
+        @link.foo
+      end
+
+      @link = Link.new(rel: 'self', href: 'http://example.org', foo: 'bar')
+      assert_equal('bar', @link.foo)
+    end
+
+    def test_templated?
+      refute(@link.templated?)
+      @link.templated = 'asdf'
+      assert(@link.templated?)
+      @link.templated = false
+      refute(@link.templated?)
+    end
+
+    def test_comparable
+      other = Link.new(rel: 'self', name: 'Self', href: 'http://example.org')
+      assert_equal(0, other <=> @link)
+
+      before = Link.new(rel: 'other', href: 'http://example.org')
+      assert_equal(-1, before <=> @link)
+
+      after = Link.new(rel: 'zoo', href: 'http://example.org')
+      assert_equal(1, after <=> @link)
+    end
+
+    def test_eql?
+      other = Link.new(rel: 'self', name: 'Self', href: 'http://example.org')
+      assert(@link.eql?(other))
+
+      other = Link.new(rel: 'other', href: 'http://example.org')
+      refute(@link.eql?(other))
+
+      other = Object.new
+      refute(@link.eql?(other))
+    end
+
+    def test_to_h
+      hash = @link.to_h
+      assert_equal('self', hash['rel'])
+      assert_equal('Self', hash['name'])
+      assert_equal('http://example.org', hash['href'])
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler'
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/pride'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: skeleton
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Johnston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: minitest
+  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: Construct an api skeleton for options
+email:
+- warmwaffles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/skeleton.rb
+- lib/skeleton/action.rb
+- lib/skeleton/builder.rb
+- lib/skeleton/example.rb
+- lib/skeleton/link.rb
+- lib/skeleton/parameter.rb
+- lib/skeleton/version.rb
+- skeleton.gemspec
+- spec/skeleton/integrated_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
+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: Construct an api skeleton for options
+test_files:
+- spec/skeleton/integrated_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