rbencode 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a601993da7cdcb5f5c758d300f789db83ffbf265
+  data.tar.gz: 45eef34189e6b66bed8d37023a80827b91a80300
+SHA512:
+  metadata.gz: 7fc8663579f82e09b7f6d571d8b2fd4827541ffa8b956f8cb127979207eeeffaac111993c9765918622733a50ebe89c08ed2becc78183b8acb9ec61691e0c222
+  data.tar.gz: 0a9cefec52f0d8a0e3c3c2854362c224c8dec28badf05b77b8d5478a2cc5ea541c88b7fd3a2e82e33ff15c21c52f256c7274aa3d0cde6c4e9aae9446968c90e3

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Documentation:
+  Exclude:
+    - test/**/*
+
+FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rbencode.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    rbencode (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bond (0.5.1)
+    minitest (5.10.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bond (~> 0.5.1)
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rbencode!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Axel Örn Sigurðsson
+
+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,44 @@
+# Rbencode
+
+A simple bencoding module, to encode and decode as specified in the [BitTorrent Protocol Specification: BEP 3](http://www.bittorrent.org/beps/bep_0003.html).
+
+This project was mainly made as a simple task to implement while learning ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rbencode'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rbencode
+
+## Usage
+
+```ruby
+Rbencode.decode('3:foo') == 'foo'
+Rbencode.encode('foo') == '3:foo'
+```
+
+See tests for more examples
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ikornaselur/rbencode.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rbencode"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'bond'
+Bond.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rbencode.rb

@@ -0,0 +1,115 @@
+require 'rbencode/version'
+
+class UnsupportedDataError < StandardError
+end
+
+class MalformedData < StandardError
+end
+
+# A bencoding module to serialize to and from the bit torrent bencoding spec
+module Rbencode
+  def self.encode(data)
+    Encoder.encode(data)
+  end
+
+  def self.decode(data)
+    decoder = Decoder.new(data)
+    decoder.decode
+  end
+end
+
+# The encoding class, to encapsulate all encoding behaviour in one module
+module Encoder
+  module_function
+
+  def self.encode(data)
+    if data.is_a? Integer
+      encode_int(data)
+    elsif data.is_a? String
+      encode_string(data)
+    elsif data.is_a? Array
+      encode_array(data)
+    elsif data.is_a? Hash
+      encode_hash(data)
+    else
+      raise UnsupportedDataError
+    end
+  end
+
+  def encode_int(data)
+    "i#{data}e"
+  end
+
+  def encode_string(data)
+    "#{data.length}:#{data}"
+  end
+
+  def encode_array(data)
+    "l#{data.collect { |item| encode(item) }.join}e"
+  end
+
+  def encode_hash(data)
+    "d#{data.to_a.flatten(1).collect { |item| encode(item) }.join}e"
+  end
+end
+
+# Decoder for a bencoded string
+class Decoder
+  def initialize(encoded)
+    @encoded_buffer = encoded.chars
+  end
+
+  def decode
+    type = @encoded_buffer[0]
+    if /[\d]/.match? type
+      parse_string
+    elsif type == 'i'
+      parse_int
+    elsif type == 'l'
+      parse_array
+    elsif type == 'd'
+      parse_hash
+    else
+      raise MalformedData
+    end
+  end
+
+  def parse_string
+    count_chars = []
+    count_chars.push(@encoded_buffer.shift) while @encoded_buffer[0] != ':'
+    @encoded_buffer.shift  # Drop the colon
+    count = count_chars.join.to_i
+
+    raise MalformedData if @encoded_buffer.length < count
+
+    @encoded_buffer.shift(count).join
+  end
+
+  def parse_int
+    @encoded_buffer.shift  # drop the i
+    int_chars = []
+    int_chars.push(@encoded_buffer.shift) while @encoded_buffer[0] != 'e'
+    @encoded_buffer.shift  # drop the e
+    int_chars.join.to_i
+  end
+
+  def parse_array
+    @encoded_buffer.shift  # drop the l
+    array = []
+    array.push(decode) while @encoded_buffer[0] != 'e'
+    @encoded_buffer.shift  # drop the e
+    array
+  end
+
+  def parse_hash
+    @encoded_buffer.shift  # drop the l
+    hash = {}
+    while @encoded_buffer[0] != 'e'
+      key = decode
+      value = decode
+      hash[key] = value
+    end
+    @encoded_buffer.shift  # drop the e
+    hash
+  end
+end

data/lib/rbencode/version.rb

@@ -0,0 +1,3 @@
+module Rbencode
+  VERSION = "0.0.1"
+end

data/rbencode.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rbencode/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rbencode'
+  spec.version       = Rbencode::VERSION
+  spec.authors       = ['Axel Örn Sigurðsson']
+  spec.email         = ['axel@takumi.com']
+
+  spec.summary       = 'A serializer for the Bit Torrent bencoding format'
+  spec.homepage      = 'https://github.com/ikornaselur/rbencode'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bond', '~> 0.5.1'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rbencode
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Axel Örn Sigurðsson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: bond
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+description: 
+email:
+- axel@takumi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rbencode.rb
+- lib/rbencode/version.rb
+- rbencode.gemspec
+homepage: https://github.com/ikornaselur/rbencode
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A serializer for the Bit Torrent bencoding format
+test_files: []