opushon 0.1.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04f7e087af188ca2457a822bb5c427898f8f24c1
-  data.tar.gz: 4a5d0680343e9ce1ee25fdfbb45078fc8249ea7f
+  metadata.gz: 12bfcf44e5abe21ffb58e9570189844ac28cf04f
+  data.tar.gz: 205212f42af692f349cd84b5047d15e015016690
 SHA512:
-  metadata.gz: a34d5465e4665d012a49f3aadcb3135ab53e7a44ae968f656d42541367c4cc80dabd79202c8956eb1b4ff73a4a4143d4d65c824aa8740c1d483270547906871b
-  data.tar.gz: d69f4bcdc6579feafda7137fc91854d30bf1339d2bdafa5bbf8eef07f61623c1a3d0158318dc0eb611aa968d8509e718cbd3f976c403daaa428583451240b059
+  metadata.gz: 4c8e46f50c20d93378ae68efa405a079b23c31cca26269971d3fa1cc010c3c18cf07ec1ed32dd5eaa3ba7c6200b011f8dbf0a44ea06956e8b58788ba8ce0e915
+  data.tar.gz: c42a59b46a9b0d48a70ff70e539fbf11799e3dd38aa37ab4b2249cf384f6780fcaad0355181caa0eb3e45ad5b891272166956d1da0b9d695ec83c2c297f25422

data/.gitignore

@@ -7,8 +7,3 @@
 /pkg/
 /spec/reports/
 /tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/.travis.yml

@@ -1,6 +1,15 @@
 language: ruby
-script: 'bundle exec rake test:coverage'
+sudo: false
+cache: bundler
+script: 'bundle exec rake test:coverage --trace'
+before_install:
+  - gem install bundler
 rvm:
-  - 2.0.0
-  - 2.1.3
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
   - ruby-head
+  - jruby
+  - jruby-head
+  - rbx-2

data/.yardopts

@@ -0,0 +1 @@
+- README.md

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.md

@@ -1,22 +1,21 @@
-Copyright (c) 2014 Cyril Wack
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2014 Cyril Wack
 
-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:
+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 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.
+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

@@ -1,6 +1,24 @@
 # Opushon
 
-An [Opushon's body](https://github.com/cyril/opushon) parser and emitter.
+[![Build Status](https://travis-ci.org/cyril/opushon.svg?branch=master)](https://travis-ci.org/cyril/opushon)
+[![Dependency Status](https://gemnasium.com/cyril/opushon.svg)](https://gemnasium.com/cyril/opushon)
+[![Gem Version](http://img.shields.io/gem/v/opushon.svg)](https://rubygems.org/gems/opushon)
+[![Inline docs](http://inch-ci.org/github/cyril/opushon.svg?branch=master)](http://inch-ci.org/github/cyril/opushon)
+[![Documentation](http://img.shields.io/:yard-docs-38c800.svg)](http://rubydoc.info/gems/opushon/frames)
+
+> An [Opushon's body](https://github.com/cyril/opushon) parser and emitter.
+
+## Contact
+
+* Home page: https://github.com/cyril/opushon
+* Bugs/issues: https://github.com/cyril/opushon/issues
+* Support: https://stackoverflow.com/questions/tagged/opushon
+
+## Rubies
+
+* [MRI](https://www.ruby-lang.org/)
+* [Rubinius](http://rubini.us/)
+* [JRuby](http://jruby.org/)
 
 ## Installation
 
@@ -22,10 +40,25 @@ Or install it yourself as:
 
 ```ruby
 # Parse some Opushon
-Opushon.load('{"DELETE":{"title": "Delete issues","description":"Remove every issues."}}') # => an Opushon instance
+opushon = Opushon.load('{
+            "DELETE": {
+              "title": "Delete issues",
+              "description": "Remove every issues.",
+              "request": {
+                "headers": {},
+                "query_string": {},
+                "body": {}
+              },
+              "response": {
+                "headers": {},
+                "query_string": {},
+                "body": {}
+              }
+            }
+          }') # => an Opushon instance
 
 # Emit some Opushon
-Opushon.dump(an Opushon instance) # => '{"DELETE":{"title": "Delete issues","description":"Remove every issues."}}'
+Opushon.dump(opushon) # => '{"DELETE":{"title":"Delete issues","description":"Remove every issues.","request":{"headers":{},"query_string":{},"body":{}},"response":{"headers":{},"query_string":{},"body":{}}}}'
 ```
 
 ## Contributing

data/Rakefile

@@ -2,7 +2,7 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.pattern = File.join 'spec', '**', '*_spec.rb'
+  t.pattern = File.join 'test', '**', 'test_*.rb'
   t.verbose = true
   t.warning = true
 end
@@ -14,4 +14,5 @@ namespace :test do
   end
 end
 
-task default: :test
+task(:doc_stats) { ruby '-S yard stats' }
+task default: [:test, :doc_stats]

data/VERSION.semver

@@ -1 +1 @@
-0.1.1
+0.2

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'opushon'
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/lib/opushon/body.rb

@@ -0,0 +1,35 @@
+require_relative 'option'
+
+module Opushon
+  # The body structure is a hash where each key is a HTTP method and each value
+  # is a sub-hash, called an option object.
+  class Body
+    include Virtus.model(strict: true)
+
+    attribute :GET,     Option, required: false
+    attribute :PATCH,   Option, required: false
+    attribute :PUT,     Option, required: false
+    attribute :POST,    Option, required: false
+    attribute :DELETE,  Option, required: false
+
+    def to_h
+      {
+        GET:    maybe_to_h(@GET),
+        PATCH:  maybe_to_h(@PATCH),
+        PUT:    maybe_to_h(@PUT),
+        POST:   maybe_to_h(@POST),
+        DELETE: maybe_to_h(@DELETE)
+      }
+    end
+
+    private
+
+    def maybe_to_h(object)
+      if object.nil?
+        nil
+      else
+        object.to_h
+      end
+    end
+  end
+end

data/lib/opushon/option.rb

@@ -0,0 +1,22 @@
+require_relative 'request'
+require_relative 'response'
+
+module Opushon
+  class Option
+    include Virtus.model(strict: true)
+
+    attribute :title,       String,   default: '',            required: true
+    attribute :description, String,   default: '',            required: true
+    attribute :request,     Request,  default: Request.new,   required: true
+    attribute :response,    Response, default: Response.new,  required: true
+
+    def to_h
+      {
+        title:        @title,
+        description:  @description,
+        request:      @request.to_h,
+        response:     @response.to_h
+      }
+    end
+  end
+end

data/lib/opushon/parameter.rb

@@ -1,9 +1,55 @@
+require_relative 'restricted_value'
+
 module Opushon
-  # Namespace for parameters parsing.
-  module Parameter
-  end
-end
+  class Parameter
+    include Virtus.model(strict: true)
+
+    attribute :title,             String,                 default: '',        required: true
+    attribute :description,       String,                 default: '',        required: true
+    attribute :type,              String,                 default: 'string',  required: true
+    attribute :nullifiable,       Boolean,                default: true,      required: true
+    attribute :restricted_values, Array[RestrictedValue],                     required: false
+    attribute :example,           BasicObject,                                required: false
+    attribute :minlen,            Fixnum,                                     required: false
+    attribute :maxlen,            Fixnum,                                     required: false
+    attribute :pattern,           Regexp,                                     required: false
+    attribute :min,               Fixnum,                                     required: false
+    attribute :max,               Fixnum,                                     required: false
+
+    def to_h
+      h = {
+        title:              @title,
+        description:        @description,
+        type:               @type,
+        nullifiable:        @nullifiable,
+        restricted_values:  maybe_to_a(@restricted_values),
+        example:            @example
+      }
 
-Dir[File.join File.dirname(__FILE__), 'parameter', '*.rb'].each do |filename|
-  require_relative filename
+      if @type.eql?('string')
+        h.update(
+          minlen:   @minlen,
+          maxlen:   @maxlen,
+          pattern:  (@pattern.nil? ? nil : @pattern.to_s)
+        )
+      end
+
+      if @type.eql?('number')
+        h.update(
+          min: @min,
+          max: @max
+        )
+      end
+    end
+
+    private
+
+    def maybe_to_a(object)
+      if object.nil?
+        nil
+      else
+        object.map(&:to_h)
+      end
+    end
+  end
 end

data/lib/opushon/request.rb

@@ -0,0 +1,19 @@
+require_relative 'parameter'
+
+module Opushon
+  class Request
+    include Virtus.model(strict: true)
+
+    attribute :headers,       Hash[Symbol => Parameter], default: {}, required: true
+    attribute :query_string,  Hash[Symbol => Parameter], default: {}, required: true
+    attribute :body,          Hash[Symbol => Parameter], default: {}, required: true
+
+    def to_h
+      {
+        headers:      @headers.map       { |k, v| [k, v.to_h] }.to_h,
+        query_string: @query_string.map  { |k, v| [k, v.to_h] }.to_h,
+        body:         @body.map          { |k, v| [k, v.to_h] }.to_h
+      }
+    end
+  end
+end

data/lib/opushon/response.rb

@@ -0,0 +1,17 @@
+require_relative 'parameter'
+
+module Opushon
+  class Response
+    include Virtus.model(strict: true)
+
+    attribute :headers, Hash[Symbol => Parameter], default: {}, required: true
+    attribute :body,    Hash[Symbol => Parameter], default: {}, required: true
+
+    def to_h
+      {
+        headers:  @headers.map { |k, v| [k, v.to_h] }.to_h,
+        body:     @body.map    { |k, v| [k, v.to_h] }.to_h
+      }
+    end
+  end
+end

data/lib/opushon/restricted_value.rb

@@ -1,29 +1,11 @@
-# Namespace for the Opushon library.
 module Opushon
-  # Parse a Opushon string in opushon.
   class RestrictedValue
-    attr_reader :value
+    include Virtus.model(strict: true)
 
-    def self.load_list(restricted_values)
-      return if restricted_values.nil?
+    attribute :title,       String,       default: '',  required: true
+    attribute :description, String,       default: '',  required: true
+    attribute :value,       BasicObject,                required: true
 
-      restricted_values.map do |restricted_value|
-        new(JSON.parse(restricted_value.to_json, symbolize_names: true)).to_h
-      end
-    end
-
-    def initialize( title:        '',
-                    description:  '',
-                    value:          )
-
-      @title        = title.to_s
-      @description  = description.to_s
-      @value        = value
-
-      freeze
-    end
-
-    # Dump instance's opushon to a hash.
     def to_h
       {
         title:        @title,

data/lib/opushon.rb

@@ -1,22 +1,36 @@
-require_relative File.join(*%w(opushon error))
-require_relative File.join(*%w(opushon instance))
-require_relative File.join(*%w(opushon version))
+require 'virtus'
+require 'json'
+require_relative File.join 'opushon', 'body'
 
 # Namespace for the Opushon library.
 #
 # @api private
 module Opushon
   class << self
-    # Load opushon in to a Ruby data structure.
+    # Load opushon in to the Ruby data structure.
+    #
     # @api public
-    def load(opushon)
-      Instance.new(opushon)
+    #
+    # @example Load the option of a DELETE interface
+    #   load('{"DELETE":{"title":"Delete issues","description":"Remove every issues.","request":{"headers":{},"query_string":{},"body":{}},"response":{"headers":{},"query_string":{},"body":{}}}}')
+    #
+    # @param [String] opushon_string
+    #
+    # @return [Body] the Ruby data structure
+    def load(opushon_string)
+      opushon_hash = JSON.load(opushon_string)
+      Body.new(opushon_hash)
     end
 
-    # Dump Ruby object o to a Opushon string.
+    # Dump Ruby object to a Opushon string.
+    #
     # @api public
-    def dump(o)
-      JSON.dump o
+    #
+    # @param [Body] opushon
+    #
+    # @return [String] the Opushon data representation
+    def dump(opushon)
+      opushon.to_h.to_json
     end
   end
 end

data/opushon.gemspec

@@ -3,18 +3,22 @@ Gem::Specification.new do |spec|
   spec.version       = File.read('VERSION.semver')
   spec.authors       = ['Cyril Wack']
   spec.email         = ['contact@cyril.email']
+
   spec.summary       = 'A HTTP Opushon parser and emitter'
   spec.description   = 'An Opushon\'s body parser and emitter.'
   spec.homepage      = 'https://github.com/cyril/opushon.rb'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(/^test\//) }
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency 'bundler',    '~> 1.7'
-  spec.add_development_dependency 'minitest',   '~> 5'
+  spec.add_dependency 'virtus',                 '~> 1.0.4'
+
+  spec.add_development_dependency 'bundler',    '~> 1.8'
   spec.add_development_dependency 'rake',       '~> 10.0'
-  spec.add_development_dependency 'coveralls',  '~> 0.7'
+  spec.add_development_dependency 'yard',       '~> 0.8'
+  spec.add_development_dependency 'simplecov',  '~> 0.9.1'
+  spec.add_development_dependency 'rubocop',    '~> 0.29'
+  spec.add_development_dependency 'expect',     '~> 0.0.6'
 end