shioruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 078ab6d07d1953d758721c8351f9729b550a1c3a
+  data.tar.gz: 00a5cd0cc1feda1aa3021e02ea90d18bbeb5d2fb
+SHA512:
+  metadata.gz: 49201063aea6f898d290ecb9ca167c673b1613b02abeecd0de7a2b685b1ae2eaa761bf8a5fa3434cdf6a087f42d132e2bfaa7d31015d644a5660d502ee59c2bd
+  data.tar.gz: d32e731c36169883b9332a383d5fcafb69cd54f0f20bc6285b81e0662275f5fc3646e46fa18c2e47f23be082965654e5a6dec3424cdfb92b5f0450337f408640

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+.*.sw?

data/.gitmodules

@@ -0,0 +1,4 @@
+[submodule "doc"]
+	path = doc
+	url = https://github.com/Narazaka/shioruby.git
+	branch = gh-pages

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format doc
+--require ./spec/spec_helper.rb

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2
+script: bundle exec rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shioruby.gemspec
+gemspec

data/README.md

@@ -0,0 +1,86 @@
+# [Shioruby](https://github.com/Narazaka/shioruby)
+
+[![Gem](https://img.shields.io/gem/v/shioruby.svg)](https://rubygems.org/gems/shioruby)
+[![Gem](https://img.shields.io/gem/dtv/shioruby.svg)](https://rubygems.org/gems/shioruby)
+[![Build Status](https://travis-ci.org/Narazaka/shioruby.svg)](https://travis-ci.org/Narazaka/shioruby)
+[![codecov.io](https://codecov.io/github/Narazaka/shioruby/coverage.svg?branch=master)](https://codecov.io/github/Narazaka/shioruby?branch=master)
+[![Code Climate](https://codeclimate.com/github/Narazaka/shioruby/badges/gpa.svg)](https://codeclimate.com/github/Narazaka/shioruby)
+
+SHIORI Protocol Parser / Builder for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shioruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shioruby
+
+## Usage
+
+```ruby
+require 'shioruby'
+
+p Shioruby.parse_request(<<-EOS
+GET SHIORI/3.0
+Charset: UTF-8
+Sender: ikagaka
+ID: OnClose
+Reference0: user
+
+EOS
+)
+#<OpenStruct method="GET", version="3.0", Charset="UTF-8", Sender="ikagaka", ID="OnClose", Reference0="user">
+
+p Shioruby.build_response(OpenStruct.new({
+  code: 200,
+  version: '3.0',
+  Value: '\h\s[0]\e',
+  Charset: 'UTF-8',
+  Sender: 'shioruby',
+}))
+#"SHIORI/3.0 200 OK\nValue: \\h\\s[0]\\e\nCharset: UTF-8\nSender: shioruby\n\n"
+
+request = Shioruby.parse_request(<<-EOS
+GET SHIORI/3.0
+Charset: UTF-8
+Sender: ikagaka
+ID: otherghostname
+Reference0: sakura\x010\x0110
+
+EOS
+)
+p request.Reference0.separated
+#["sakura", "0", "10"]
+
+# sakura.recommendsites etc.
+sites = [
+  ['Shioruby', 'https://github.com/Narazaka/shioruby', '', '\h\s[0]This is Shioruby site.\e'],
+  ['ShioriJK', 'https://github.com/Narazaka/shiorijk', '', '\h\s[0]This is ShioriJK site.\e'],
+]
+response_str = Shioruby.build_response(OpenStruct.new({
+  code: 200,
+  version: '3.0',
+  Value: sites.combined2,
+  Charset: 'UTF-8',
+  Sender: 'shioruby',
+}))
+p response_str
+#"SHIORI/3.0 200 OK\nValue: Shioruby\u0001https://github.com/Narazaka/shioruby\u0001\u0001\\h\\s[0]This is Shioruby site.\\e\u0002ShioriJK\u0001https://github.com/Narazaka/shiorijk\u0001\u0001\\h\\s[0]This is ShioriJK site.\\e\nCharset: UTF-8\nSender: shioruby\n\n"
+```
+
+## API
+
+[API Document](https://narazaka.github.io/shioruby/index.html)
+
+## License
+
+This is released under [MIT License](http://narazaka.net/license/MIT?2016).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new
+YARD::Rake::YardocTask.new

data/lib/shioruby.rb

@@ -0,0 +1,96 @@
+require 'ostruct'
+
+# SHIORI Protocol Parser / Builder
+module Shioruby
+
+  # response messages for status codes
+  @@response_message = {
+    200 => 'OK',
+    204 => 'No Content',
+    310 => 'Communicate',
+    311 => 'Not Enough',
+    312 => 'Advice',
+    400 => 'Bad Request',
+    418 => "I'm a tea pot",
+    451 => 'Unavailable For Legal Reasons',
+    500 => 'Internal Server Error',
+  }
+
+  class << self
+
+    # parse SHIORI/3.x Request
+    # @param [String] request_str SHIORI/3.x Request string
+    # @return [OpenStruct] SHIORI/3.x Request object
+    def parse_request(request_str)
+      lines = request_str.each_line.map(&:chomp).reject(&:empty?)
+      request_line = lines.shift
+      unless request_line_result = request_line.match(/^(.+) SHIORI\/([\d.]+)$/)
+        raise ParseError.new("invalid request line")
+      end
+      request = OpenStruct.new
+      request.method = request_line_result[1]
+      request.version = request_line_result[2]
+      lines.each do |line|
+        unless header_result = line.match(/^(.+?): (.*)$/)
+          raise ParseError.new("invalid header")
+        end
+        request[header_result[1]] = header_result[2]
+      end
+      request
+    end
+
+    # build SHIORI/3.x Response
+    # @param [OpenStruct] response SHIORI/3.x Response object
+    # @return [String] SHIORI/3.x Response string
+    def build_response(response)
+      message = response.message || @@response_message[response.code]
+      response.version
+      lines = ["SHIORI/#{response.version} #{response.code} #{message}"]
+      response.each_pair.reject {|key, _| ['code', 'message', 'version', :code, :message, :version].include?(key)}.each do |key, value|
+        lines << "#{key}: #{value}"
+      end
+      lines.join("\n") + "\n\n"
+    end
+
+  end
+
+  # parse error
+  class ParseError < RuntimeError
+  end
+end
+
+# convenient for SHIORI Request treatment
+class String
+  # split \\x01 separated Reference* value like "arg1\\x01arg2\\x01arg3" into Array
+  # @param [String] separator separator
+  # @return [Array<String>] separated strings
+  def separated(separator = "\x01")
+    self.split(separator)
+  end
+
+  # split \\x01, \\x02 separated Reference* value like "arg1-1\\x01arg1-2\\x02arg2-1\\x01arg2-2" into Array of Array
+  # @param [String] separator1 1st level separator
+  # @param [String] separator2 2nd level separator
+  # @return [Array<Array<String>>] separated strings
+  def separated2(separator1 = "\x02", separator2 = "\x01")
+    self.split(separator1).map {|element| element.split(separator2)}
+  end
+end
+
+# convenient for SHIORI Response treatment
+class Array
+  # join \\x01 separated value like "arg1\\x01arg2\\x01arg3" from Array
+  # @param [String] separator separator
+  # @return [String] combined strings
+  def combined(separator = "\x01")
+    self.join(separator)
+  end
+
+  # join \\x01, \\x02 separated value like "arg1-1\\x01arg1-2\\x02arg2-1\\x01arg2-2" from Array of Array
+  # @param [String] separator1 1st level separator
+  # @param [String] separator2 2nd level separator
+  # @return [String] combined strings
+  def combined2(separator1 = "\x02", separator2 = "\x01")
+    self.map {|element| element.join(separator2)}.join(separator1)
+  end
+end

data/shioruby.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "shioruby"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Narazaka"]
+  spec.email         = ["info@narazaka.net"]
+
+  spec.summary       = %q{SHIORI Protocol Parser / Builder}
+  spec.description   = %q{Ukagaka SHIORI Protocol Request Parser / Response Builder}
+  spec.homepage      = "https://github.com/Narazaka/shioruby"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.7.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "yard", "~> 0.8.7"
+  spec.add_development_dependency "simplecov", "~> 0.11"
+  spec.add_development_dependency "codecov", "~>0.1"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: shioruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Narazaka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-24 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.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Ukagaka SHIORI Protocol Request Parser / Response Builder
+email:
+- info@narazaka.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/shioruby.rb
+- shioruby.gemspec
+homepage: https://github.com/Narazaka/shioruby
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: SHIORI Protocol Parser / Builder
+test_files: []
+has_rdoc: