opushon 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 651d12bd2b0f56b85c3cc5a5a5de3b1d2caf285b
+  data.tar.gz: 9eac2b5b7e0dce96c0db5ac5aaa26d860263dd53
+SHA512:
+  metadata.gz: aa3758fb3d93c9ddc489541a392d54c54400e226562e97bd03ef5a832cb28646e5a4dbc917ba081e7a777b1a208a6842534df5d0d503d363c0679f477c298a3b
+  data.tar.gz: 43e02e8f85644870cdc5ae64615c529227c39e913ebe48c9700c2a39b1b3990699db32cd699ac794697960a6b46c144612fdf63a47fbcba5f93950fb329f1ff9

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0-preview2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: 'bundle exec rake test:coverage'
+rvm:
+  - 2.0.0
+  - 2.1.3
+  - ruby-head

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cyril Wack
+
+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,37 @@
+# Opushon
+
+An [Opushon's body](https://github.com/cyril/opushon) parser and emitter.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'opushon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opushon
+
+## Usage
+
+```ruby
+# Parse some Opushon
+Opushon.load('{"DELETE":{"title": "Delete issues","description":"Remove every issues."}}') # => an Opushon instance
+
+# Emit some Opushon
+Opushon.dump(an Opushon instance) # => '{"DELETE":{"title": "Delete issues","description":"Remove every issues."}}'
+```
+
+## Contributing
+
+1. [Fork it](https://github.com/cyril/opushon.rb/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = File.join 'spec', '**', '*_spec.rb'
+  t.verbose = true
+  t.warning = true
+end
+
+namespace :test do
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test'].invoke
+  end
+end
+
+task(:doc_stats) { ruby '-S yard stats' }
+task default: [:test, :doc_stats]

data/VERSION.semver

@@ -0,0 +1 @@
+0.0.1

data/lib/opushon/attribute.rb

@@ -0,0 +1,29 @@
+require_relative 'type'
+
+# Namespace for the Opushon library.
+module Opushon
+  # Parse a Opushon string in opushon.
+  class Attribute
+    def initialize(properties)
+      type            = properties.delete('type')         { 'string' }
+      @type           = Type.const_get(type.capitalize).new(properties)
+
+      @nullifiable    = properties.delete('nullifiable')  { true }
+      @multiple       = properties.delete('multiple')     { false }
+      @description    = properties.delete('description')  { '' }
+      @options        = properties.delete('options')      { nil }
+
+      @other_settings = properties
+    end
+
+    # Dump attribute's properties to a hash.
+    def to_h
+      {
+        'nullifiable' =>  @nullifiable,
+        'multiple'    =>  @multiple,
+        'description' =>  @description,
+        'options'     =>  @options
+      }.merge(@other_settings).merge(@type.to_h)
+    end
+  end
+end

data/lib/opushon/error/base_error.rb

@@ -0,0 +1,6 @@
+# Namespace for the Opushon library.
+module Opushon
+  # Raised if anything goes wrong.
+  class BaseError < RuntimeError
+  end
+end

data/lib/opushon/error/syntax_error.rb

@@ -0,0 +1,8 @@
+require_relative 'base_error'
+
+# Namespace for the Opushon library.
+module Opushon
+  # Raised if anything goes wrong while parsing a string.
+  class SyntaxError < BaseError
+  end
+end

data/lib/opushon/error/verb_error.rb

@@ -0,0 +1,8 @@
+require_relative 'syntax_error'
+
+# Namespace for the Opushon library.
+module Opushon
+  # Raised if anything goes wrong while parsing a verb.
+  class VerbError < SyntaxError
+  end
+end

data/lib/opushon/error.rb

@@ -0,0 +1,3 @@
+Dir[File.join File.dirname(__FILE__), 'error', '**' '*.rb'].each do |filename|
+  require_relative filename
+end

data/lib/opushon/instance.rb

@@ -0,0 +1,43 @@
+require_relative 'option'
+require_relative 'option_object'
+require_relative 'verb'
+require 'json'
+
+# Namespace for the Opushon library.
+module Opushon
+  # Parse a Opushon string in opushon.
+  class Instance
+    def initialize(opushon)
+      o = JSON.load opushon
+
+      unless o.is_a?(Hash)
+        fail SyntaxError
+      end
+
+      unless o.keys.map(&:to_sym).to_set.subset? VERBS
+        fail VerbError
+      end
+
+      @options = {}
+      o.each do |verb, option_object|
+        @options.update verb => OptionObject.new(verb, option_object)
+      end
+    end
+
+    # Dump instance's opushon to a hash.
+    #
+    # @api public
+    def to_h
+      Hash[@options.each { |k,v| @options[k] = v.to_h }]
+    end
+
+    # Runs all the validations within the current context.
+    #
+    # @return [Boolean] Returns true if no errors are found, false otherwise.
+    #
+    # @api public
+    def valid?(verb, example)
+      @options.fetch(verb.to_s).valid? example
+    end
+  end
+end

data/lib/opushon/option.rb

@@ -0,0 +1,14 @@
+# Namespace for the Opushon library.
+module Opushon
+  # Parse a Opushon string in opushon.
+  class Option
+    def initialize(option_object)
+      @option_object = option_object
+    end
+
+    # Dump instance's opushon to a hash.
+    def to_h
+      @option_object.to_h
+    end
+  end
+end

data/lib/opushon/option_object.rb

@@ -0,0 +1,56 @@
+require_relative 'attribute'
+require_relative 'verb'
+
+# Namespace for the Opushon library.
+module Opushon
+  # Parse a Opushon string in opushon.
+  class OptionObject
+    def initialize(verb, members)
+      @verb           = verb
+      @title          = members.delete('title')         { '' }
+      @description    = members.delete('description')   { '' }
+
+      @query_string   = {}
+      query_string    = members.delete('query_string')  { Hash.new }
+      query_string.each do |key, properties|
+        @query_string.update key => Attribute.new(properties)
+      end
+
+      @parameters     = {}
+      parameters      = members.delete('parameters')    { Hash.new }
+      parameters.each do |key, properties|
+        @parameters.update key => Attribute.new(properties)
+      end
+
+      @example        = members.delete('example')       { nil }
+
+      unless @example.nil?
+        fail InvalidExample unless valid?(@example)
+      end
+
+      @other_settings = members
+    end
+
+    # Dump option object's members to a hash.
+    def to_h
+      {
+        'title'         => @title,
+        'description'   => @description,
+        'query_string'  => @query_string.each { |k,v| @query_string[k] = v.to_h },
+        'parameters'    => @parameters.each   { |k,v| @parameters[k]   = v.to_h },
+        'example'       => @example
+      }.merge(@other_settings)
+    end
+
+    # Runs all the validations within the current context.
+    #
+    # @return [Boolean] Returns true if no errors are found, false otherwise.
+    def valid?(example)
+      unless VERBS.include?(@verb.to_sym)
+        fail VerbError
+      end
+
+      true
+    end
+  end
+end

data/lib/opushon/type/base.rb

@@ -0,0 +1,18 @@
+# Namespace for the Opushon library.
+module Opushon
+  module Type
+    # Abstract class.
+    class Base
+      def default
+        nil
+      end
+
+      def to_h
+        {
+          'default' => default,
+          'type'    => self.class.name.split('::').last.downcase
+        }
+      end
+    end
+  end
+end

data/lib/opushon/type/boolean.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+
+# Namespace for the Opushon library.
+module Opushon
+  module Type
+    # The type boolean.
+    class Boolean < Base
+      def default
+        false
+      end
+    end
+  end
+end

data/lib/opushon/type/number.rb

@@ -0,0 +1,27 @@
+require_relative 'base'
+
+# Namespace for the Opushon library.
+module Opushon
+  module Type
+    # The type number.
+    class Number < Base
+      def initialize(constraints)
+        @min  = constraints.delete('min')   { nil }
+        @max  = constraints.delete('max')   { nil }
+        @step = constraints.delete('step')  { nil }
+      end
+
+      def default
+        0
+      end
+
+      def to_h
+        super.merge({
+          'min'   => @min,
+          'max'   => @max,
+          'step'  => @step
+        })
+      end
+    end
+  end
+end

data/lib/opushon/type/string.rb

@@ -0,0 +1,27 @@
+require_relative 'base'
+
+# Namespace for the Opushon library.
+module Opushon
+  module Type
+    # The type string.
+    class String < Base
+      def initialize(constraints)
+        @minlen  = constraints.delete('minlen')   { nil }
+        @maxlen  = constraints.delete('maxlen')   { nil }
+        @pattern = constraints.delete('pattern')  { nil }
+      end
+
+      def default
+        ''
+      end
+
+      def to_h
+        super.merge({
+          'minlen'  => @minlen,
+          'maxlen'  => @maxlen,
+          'pattern' => @pattern
+        })
+      end
+    end
+  end
+end

data/lib/opushon/type.rb

@@ -0,0 +1,10 @@
+# Namespace for the Opushon library.
+module Opushon
+  # Contains available types.
+  module Type
+  end
+end
+
+Dir[File.join File.dirname(__FILE__), 'type', '*.rb'].each do |filename|
+  require_relative filename
+end

data/lib/opushon/verb/base.rb

@@ -0,0 +1,7 @@
+module Opushon
+  module Verb
+    # Global verb object structure.
+    class Base
+    end
+  end
+end

data/lib/opushon/verb/delete.rb

@@ -0,0 +1,9 @@
+require_relative 'base'
+
+module Opushon
+  module Verb
+    # HTTP DELETE verb object
+    class Delete
+    end
+  end
+end

data/lib/opushon/verb/get.rb

@@ -0,0 +1,9 @@
+require_relative 'base'
+
+module Opushon
+  module Verb
+    # HTTP GET verb object
+    class Get
+    end
+  end
+end

data/lib/opushon/verb/head.rb

@@ -0,0 +1,9 @@
+require_relative 'base'
+
+module Opushon
+  module Verb
+    # HTTP HEAD verb object
+    class Head
+    end
+  end
+end

data/lib/opushon/verb/patch.rb

@@ -0,0 +1,9 @@
+require_relative 'base'
+
+module Opushon
+  module Verb
+    # HTTP PATCH verb object
+    class Patch
+    end
+  end
+end

data/lib/opushon/verb/post.rb

@@ -0,0 +1,9 @@
+require_relative 'base'
+
+module Opushon
+  module Verb
+    # HTTP POST verb object
+    class Post
+    end
+  end
+end

data/lib/opushon/verb/put.rb

@@ -0,0 +1,9 @@
+require_relative 'base'
+
+module Opushon
+  module Verb
+    # HTTP PUT verb object
+    class Put
+    end
+  end
+end

data/lib/opushon/verb.rb

@@ -0,0 +1,11 @@
+require 'set'
+
+Dir[File.join File.dirname(__FILE__), 'verb', '*.rb'].each do |filename|
+  require_relative filename
+end
+
+# Namespace for the Opushon library.
+module Opushon
+  # Allowed verbs
+  VERBS = Verb.constants.delete_if { |sym| sym.equal?(:Base) }.map(&:upcase).to_set
+end

data/lib/opushon/version.rb

@@ -0,0 +1,7 @@
+# Namespace for the Opushon library.
+module Opushon
+  # Gem version
+  VERSION = File.open(
+    Pathname.new(__FILE__).join '..', '..', '..', 'VERSION.semver'
+  ).read.chomp.to_sym
+end

data/lib/opushon.rb

@@ -0,0 +1,22 @@
+require_relative File.join(*%w(opushon error))
+require_relative File.join(*%w(opushon instance))
+require_relative File.join(*%w(opushon version))
+
+# Namespace for the Opushon library.
+#
+# @api private
+module Opushon
+  class << self
+    # Load opushon in to a Ruby data structure.
+    # @api public
+    def load(opushon)
+      Instance.new(opushon)
+    end
+
+    # Dump Ruby object o to a Opushon string.
+    # @api public
+    def dump(o)
+      JSON.dump o
+    end
+  end
+end

data/opushon.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'opushon'
+  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.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_development_dependency 'rake',       '~> 10.0'
+  spec.add_development_dependency 'yard',       '~> 0.8'
+  spec.add_development_dependency 'coveralls',  '~> 0.7'
+end

data/spec/opushon/spec_helper.rb

@@ -0,0 +1 @@
+require_relative File.join(*%w(.. spec_helper))

data/spec/opushon/version_spec.rb

@@ -0,0 +1,9 @@
+require_relative 'spec_helper'
+
+describe Opushon::VERSION do
+  it 'MUST return the version' do
+    Opushon::VERSION.must_equal File.open(
+      Pathname.new(__FILE__).join(*%w(.. .. .. VERSION.semver))
+    ).read.chomp.to_sym
+  end
+end

data/spec/opushon_spec.rb

@@ -0,0 +1,353 @@
+require_relative 'spec_helper'
+
+describe Opushon do
+  describe '.load' do
+    let :options_account do
+      Opushon.load('{
+        "DELETE": {
+          "title": "Delete account",
+          "description": "Remove my account please!!",
+          "foo": "bar"
+        }
+      }')
+    end
+
+    let :options_issues do
+      Opushon.load('{
+        "GET": {
+          "title": "List issues",
+          "description": "List all issues across all the authenticated user\'s visible repositories.",
+          "query_string": {
+            "page": {
+              "type": "number",
+              "description": "Identify the page to return.",
+              "min": 1,
+              "max": null,
+              "step": 1
+            },
+            "per_page": {
+              "type": "number",
+              "description": "Indicate the number of issues per page.",
+              "min": 1,
+              "max": 100,
+              "step": 1
+            },
+            "state": {
+              "description": "Indicates the state of the issues to return.",
+              "options": {
+                "open": "Open",
+                "closed": "Closed",
+                "all": "All"
+              },
+              "default": "open",
+              "multiple": true,
+              "nullifiable": true
+            }
+          },
+          "parameters": {
+            "created_at": {
+              "type": "string",
+              "description": "The datetime that the resource was created at.",
+              "nullifiable": false
+            },
+            "title": {
+              "type": "string",
+              "description": "The title of the resource.",
+              "maxlen": 255,
+              "nullifiable": false
+            },
+            "body": {
+              "type": "string",
+              "description": "The body of the resource.",
+              "maxlen": 10000,
+              "nullifiable": true
+            },
+            "state": {
+              "type": "string",
+              "description": "Indicates the state of the issue.",
+              "maxlen": 255,
+              "options": {
+                "open": "Open",
+                "closed": "Closed",
+                "all": "All"
+              },
+              "multiple": false,
+              "nullifiable": false
+            }
+          },
+          "example": [
+            {
+              "created_at": "2014-01-01T01:01:01Z",
+              "title": "Found a bug",
+              "body": "I\'m having a problem with this.",
+              "state": "open"
+            }
+          ]
+        },
+        "POST": {
+          "title": "Create an issue",
+          "description": "Any user with pull access to a repository can create an issue.",
+          "query_string": {},
+          "parameters": {
+            "title": {
+              "type": "string",
+              "description": "Issue title.",
+              "maxlen": 255,
+              "nullifiable": false
+            },
+            "body": {
+              "type": "string",
+              "description": "Issue body.",
+              "nullifiable": true
+            },
+            "labels": {
+              "type": "string",
+              "description": "Labels to associate with this issue.",
+              "multiple": true,
+              "nullifiable": true,
+              "options": {
+                "label_1": "Java",
+                "label_2": "Ruby",
+                "label_3": "Elixir"
+              }
+            }
+          },
+          "example": {
+            "title": "Found a bug",
+            "body": "I\'m having a problem with this.",
+            "labels": [
+              "label_1",
+              "label_2"
+            ]
+          }
+        },
+        "DELETE": {
+          "title": "Delete issues",
+          "description": "Remove every issues."
+        }
+      }')
+    end
+
+    it 'MUST raise a JSON parser error' do
+      lambda do
+        Opushon.load('{"DELETE":{"title":"Delete issues"')
+      end.must_raise(JSON::ParserError)
+    end
+
+    it 'MUST raise a Opushon syntax error' do
+      lambda do
+        Opushon.load('["BOOM"]')
+      end.must_raise(Opushon::SyntaxError)
+    end
+
+    it 'MUST raise a Opushon verb error' do
+      lambda do
+        Opushon.load('{"BOOM":{}}')
+      end.must_raise(Opushon::VerbError)
+    end
+
+    describe '#to_h' do
+      it 'MUST load opushon in to a Ruby data structure' do
+        options_account.to_h.must_equal({
+          'DELETE' => {
+            'title'         => 'Delete account',
+            'description'   => 'Remove my account please!!',
+            'query_string'  => {},
+            'parameters'    => {},
+            'example'       => nil,
+            'foo'           => 'bar'
+          }
+        })
+      end
+
+      it 'MUST load opushon having query_string and parameters' do
+        options_issues.to_h.must_equal({
+          "GET"=>{
+            "title"=>"List issues",
+            "description"=>"List all issues across all the authenticated user's visible repositories.",
+            "query_string"=>{
+              "page"=>{
+                "nullifiable"=>true,
+                "multiple"=>false,
+                "description"=>"Identify the page to return.",
+                "options"=>nil,
+                "default"=>0,
+                "type"=>"number",
+                "min"=>1,
+                "max"=>nil,
+                "step"=>1
+              },
+              "per_page"=>{
+                "nullifiable"=>true,
+                "multiple"=>false,
+                "description"=>"Indicate the number of issues per page.",
+                "options"=>nil,
+                "default"=>0,
+                "type"=>"number",
+                "min"=>1,
+                "max"=>100,
+                "step"=>1
+              },
+              "state"=>{
+                "nullifiable"=>true,
+                "multiple"=>true,
+                "description"=>"Indicates the state of the issues to return.",
+                "options"=>{
+                  "open"=>"Open",
+                  "closed"=>"Closed",
+                  "all"=>"All"
+                },
+                "default"=>"",
+                "type"=>"string",
+                "minlen"=>nil,
+                "maxlen"=>nil,
+                "pattern"=>nil
+              }
+            },
+            "parameters"=>{
+              "created_at"=>{
+                "nullifiable"=>false,
+                "multiple"=>false,
+                "description"=>"The datetime that the resource was created at.",
+                "options"=>nil,
+                "default"=>"",
+                "type"=>"string",
+                "minlen"=>nil,
+                "maxlen"=>nil,
+                "pattern"=>nil
+              },
+              "title"=>{
+                "nullifiable"=>false,
+                "multiple"=>false,
+                "description"=>"The title of the resource.",
+                "options"=>nil,
+                "default"=>"",
+                "type"=>"string",
+                "minlen"=>nil,
+                "maxlen"=>255,
+                "pattern"=>nil
+              },
+              "body"=>{
+                "nullifiable"=>true,
+                "multiple"=>false,
+                "description"=>"The body of the resource.",
+                "options"=>nil,
+                "default"=>"",
+                "type"=>"string",
+                "minlen"=>nil,
+                "maxlen"=>10000,
+                "pattern"=>nil
+              },
+              "state"=>{
+                "nullifiable"=>false,
+                "multiple"=>false,
+                "description"=>"Indicates the state of the issue.",
+                "options"=>{
+                  "open"=>"Open",
+                  "closed"=>"Closed",
+                  "all"=>"All"
+                },
+                "default"=>"",
+                "type"=>"string",
+                "minlen"=>nil,
+                "maxlen"=>255,
+                "pattern"=>nil
+              }
+            },
+            "example"=>[
+              {
+                "created_at"=>"2014-01-01T01:01:01Z",
+                "title"=>"Found a bug",
+                "body"=>"I'm having a problem with this.",
+                "state"=>"open"
+              }
+            ]
+          },
+          "POST"=>{
+            "title"=>"Create an issue",
+            "description"=>"Any user with pull access to a repository can create an issue.",
+            "query_string"=>{},
+            "parameters"=>{
+              "title"=>{
+                "nullifiable"=>false,
+                "multiple"=>false,
+                "description"=>"Issue title.",
+                "options"=>nil,
+                "default"=>"",
+                "type"=>"string",
+                "minlen"=>nil,
+                "maxlen"=>255,
+                "pattern"=>nil
+              },
+              "body"=>{
+                "nullifiable"=>true,
+                "multiple"=>false,
+                "description"=>"Issue body.",
+                "options"=>nil,
+                "default"=>"",
+                "type"=>"string",
+                "minlen"=>nil,
+                "maxlen"=>nil,
+                "pattern"=>nil
+              },
+              "labels"=>{
+                "nullifiable"=>true,
+                "multiple"=>true,
+                "description"=>"Labels to associate with this issue.",
+                "options"=>{
+                  "label_1"=>"Java",
+                  "label_2"=>"Ruby",
+                  "label_3"=>"Elixir"
+                },
+                "default"=>"",
+                "type"=>"string",
+                "minlen"=>nil,
+                "maxlen"=>nil,
+                "pattern"=>nil
+              }
+            },
+            "example"=>{
+              "title"=>"Found a bug",
+              "body"=>"I'm having a problem with this.",
+              "labels"=>[
+                "label_1",
+                "label_2"
+              ]
+            }
+          },
+          "DELETE"=>{
+            "title"=>"Delete issues",
+            "description"=>"Remove every issues.",
+            "query_string"=>{},
+            "parameters"=>{},
+            "example"=>nil
+          }
+        })
+      end
+    end
+
+    describe '#valid?' do
+      it 'MUST valid the Ruby object o to a Opushon string' do
+        options_issues.valid?(:POST, {
+          "title"   => "Found a bug",
+          "body"    => "I'm having a problem with this.",
+          "labels"  => [
+            "label_1",
+            "label_2"
+          ]
+        }).must_equal(true)
+      end
+    end
+  end
+
+  describe '.dump' do
+    it 'MUST dump Ruby object o to a Opushon string' do
+      Opushon.dump({
+        DELETE: {
+          title:        'Delete issues',
+          description:  'Remove every issues.'
+        }
+      }).must_equal('{"DELETE":{"title":"Delete issues","description":"Remove every issues."}}')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+
+require_relative 'support'
+require_relative File.join(*%w(.. lib opushon))

data/spec/support/coverage.rb

@@ -0,0 +1,9 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start

data/spec/support/env.rb

@@ -0,0 +1 @@
+abort "Needs Ruby 2, you're running: #{RUBY_VERSION}" if RUBY_VERSION < '2'

data/spec/support/immutable.rb

@@ -0,0 +1,15 @@
+class Object
+  alias_method :overridden_initialize, :initialize
+
+  def initialize
+    overridden_initialize
+
+    if  !self.class.ancestors.include?(SimpleCov::Formatter::MultiFormatter)  &&
+        !self.class.ancestors.include?(SimpleCov::Formatter::HTMLFormatter)   &&
+        !self.class.ancestors.include?(Minitest::CompositeReporter)           &&
+        !self.class.ancestors.include?(Minitest::SummaryReporter)             &&
+        !self.class.ancestors.include?(Minitest::ProgressReporter)
+      freeze
+    end
+  end
+end

data/spec/support.rb

@@ -0,0 +1,3 @@
+Dir[File.join File.dirname(__FILE__), 'support', '**' '*.rb'].each do |filename|
+  require_relative filename
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: opushon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cyril Wack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: An Opushon's body parser and emitter.
+email:
+- contact@cyril.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION.semver
+- lib/opushon.rb
+- lib/opushon/attribute.rb
+- lib/opushon/error.rb
+- lib/opushon/error/base_error.rb
+- lib/opushon/error/syntax_error.rb
+- lib/opushon/error/verb_error.rb
+- lib/opushon/instance.rb
+- lib/opushon/option.rb
+- lib/opushon/option_object.rb
+- lib/opushon/type.rb
+- lib/opushon/type/base.rb
+- lib/opushon/type/boolean.rb
+- lib/opushon/type/number.rb
+- lib/opushon/type/string.rb
+- lib/opushon/verb.rb
+- lib/opushon/verb/base.rb
+- lib/opushon/verb/delete.rb
+- lib/opushon/verb/get.rb
+- lib/opushon/verb/head.rb
+- lib/opushon/verb/patch.rb
+- lib/opushon/verb/post.rb
+- lib/opushon/verb/put.rb
+- lib/opushon/version.rb
+- opushon.gemspec
+- spec/opushon/spec_helper.rb
+- spec/opushon/version_spec.rb
+- spec/opushon_spec.rb
+- spec/spec_helper.rb
+- spec/support.rb
+- spec/support/coverage.rb
+- spec/support/env.rb
+- spec/support/immutable.rb
+homepage: https://github.com/cyril/opushon.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: A HTTP Opushon parser and emitter
+test_files:
+- spec/opushon/spec_helper.rb
+- spec/opushon/version_spec.rb
+- spec/opushon_spec.rb
+- spec/spec_helper.rb
+- spec/support.rb
+- spec/support/coverage.rb
+- spec/support/env.rb
+- spec/support/immutable.rb
+has_rdoc: