fastdfs-client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 711de59fe7605cadbe4820f3f852e79860e5c1ab
+  data.tar.gz: cd68e14f5f1932d19045e5c3c31fa77e91d75472
+SHA512:
+  metadata.gz: 673c80215e1b30fea0aae0f2b3b2471d6641027491f548365213915762cb092f8fec7d6643bbf3c7fc22501e534eb730f22e495e08253de45a4fda92cbe88374
+  data.tar.gz: 310349702c4c17c9316cae1a165c9f305a88f34445023a5f75139d26741a9642bdddcb5ca3176407211ec7e2f1c41c9cb7a83b384f838077dcd55b385be76a58

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://gems.ruby-china.org/'
+
+gemspec
+
+group :test, :development do
+  gem 'debugger'
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    fastdfs-client (0.0.2)
+
+GEM
+  remote: http://gems.ruby-china.org/
+  specs:
+    columnize (0.9.0)
+    debugger (1.6.8)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.5)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.8)
+    diff-lcs (1.2.5)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  debugger
+  fastdfs-client!
+  rspec

data/README.md

@@ -0,0 +1,21 @@
+# fastdfs-client-ruby
+
+fastdfs client for ruby 
+
+### Install
+
+    #Gemfile
+    gem 'fastdfs-client', git: "git@github.com:huxinghai1988/fastdfs-client-ruby.git"
+
+### Using
+
+```RUBY
+  tracker = new Fastdfs::Client::Tracker("192.168.1.1", "22122")
+
+  @storage = tracker.get_storage
+
+  @storage.upload(@file)
+
+  #group_name + path
+  @storage.delete(path)
+```

data/fastdfs-client.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fastdfs-client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fastdfs-client"
+  spec.version       = Fastdfs::Client::VERSION
+  spec.authors       = ["Ka Ka"]
+  spec.email         = ["huxinghai1988@gmail.com"]
+  spec.description   = "fastdfs upload file client for ruby"
+  spec.summary       = "fastdfs upload file client for ruby"
+  spec.homepage      = "https://github.com/huxinghai1988/fastdfs-client-ruby.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+end

data/lib/fastdfs-client.rb

@@ -0,0 +1,7 @@
+require "fastdfs-client/extend_core"
+require 'fastdfs-client/socket'
+require 'fastdfs-client/cmd'
+require 'fastdfs-client/proto_common'
+require 'fastdfs-client/utils'
+require 'fastdfs-client/hook'
+require "fastdfs-client/tracker"

data/lib/fastdfs-client/cmd.rb

@@ -0,0 +1,12 @@
+module Fastdfs
+  module Client
+
+    module CMD
+      STORE_WITHOUT_GROUP_ONE = 101
+      UPLOAD_FILE = 11
+      RESP_CODE = 100
+      DELETE_FILE = 12
+    end
+
+  end
+end

data/lib/fastdfs-client/extend_core.rb

@@ -0,0 +1,14 @@
+
+class Array
+  def to_pack_long
+    self.each_with_index.inject(0){|s, item| s = s | (item[0] << (56 - (item[1] * 8))); s }
+  end
+  
+end
+
+class Object
+
+  def blank?
+    self.empty? || self.nil?
+  end
+end

data/lib/fastdfs-client/hook.rb

@@ -0,0 +1,41 @@
+module Hook
+  def before(*meth_names, &callback)
+    meth_names.each{|meth_name| add_hook :before, meth_name, &callback }
+  end
+  
+  def after(*meth_names, &callback)
+    meth_names.each{|meth_name| add_hook :after, meth_name, &callback }
+  end
+  
+  def hooks
+    @hooks ||= Hash.new do |hash, method_name|
+      hash[method_name] = { before: [], after: [], hijacked: false }
+    end
+  end
+  
+  def add_hook(where, meth_name, &callback)
+    hooks[meth_name][where] << callback
+    ensure_hijacked meth_name
+  end
+  
+  def method_added(meth_name)
+    ensure_hijacked meth_name if hooks.has_key? meth_name
+  end
+  
+  def ensure_hijacked(meth_name)
+    return if hooks[meth_name][:hijacked] || !instance_methods.include?(meth_name)
+    meth = instance_method meth_name
+    _hooks = hooks
+    _hooks[meth_name][:hijacked] = true
+    define_method meth_name do |*args, &block|
+      _hooks[meth_name][:before].each do |callback|
+        self.instance_exec(&callback)
+      end
+      return_value = meth.bind(self).call *args, &block
+      _hooks[meth_name][:after].each do |callback|
+        self.instance_exec(&callback)
+      end
+      return_value
+    end
+  end
+end

data/lib/fastdfs-client/proto_common.rb

@@ -0,0 +1,24 @@
+module Fastdfs
+  module Client
+
+    module ProtoCommon
+      TRACKER_BODY_LEN = 40
+      
+      IPADDR = 16...31
+      PORT = 31...-1
+      SIZE_LEN = 9
+      HEAD_LEN = 10
+      EXTNAME_LEN = 6
+      GROUP_NAME_MAX_LEN = 16
+
+      def self.header_bytes(cmd, hex_long, erron=0)
+        hex_bytes = Utils.number_to_Buffer(hex_long)
+        header = hex_bytes.fill(0, hex_bytes.length...HEAD_LEN)
+        header[8] = cmd
+        header[9] = erron
+        header
+      end
+    end
+
+  end
+end

data/lib/fastdfs-client/socket.rb

@@ -0,0 +1,69 @@
+require 'socket'
+require 'timeout'
+require 'fastdfs-client/cmd'
+
+
+module Fastdfs
+  module Client
+
+    class Socket
+      attr_accessor :header, :content, :header_len, :cmd, :socket, :host, :port
+
+      def initialize(host, port, options = {})
+        @host = host
+        @port = port
+        connection
+        @header_len = ProtoCommon::HEAD_LEN
+        @options = options || {}
+        @connection_timeout = @options[:connection_timeout] || 3
+        @recv_timeout = @options[:recv_timeout] || 3
+      end
+
+      def write(*args)
+        @cmd = args.shift
+        pkg = args.shift
+        pkg = pkg.pack("C*") if pkg.is_a?(Array)
+        @socket.write pkg
+      end
+
+      def close 
+        @socket.close if connected
+      end
+
+      def connection
+        if @socket.nil? || !connected
+          Timeout.timeout(@connection_timeout) do
+            @socket = TCPSocket.new(@host, @port)  
+          end
+        end
+      end
+
+      def connected
+        !@socket.closed?
+      end
+
+      def receive
+        @content = nil
+        Timeout.timeout(@recv_timeout) do 
+          @header = @socket.recv(@header_len).unpack("C*")
+        end
+        res_header = parseHeader
+        if res_header[:body_length] > 0
+          Timeout.timeout(@recv_timeout) do 
+            @content = @socket.recv(@header.to_pack_long) 
+          end
+        end
+        yield @content if block_given?
+      end
+
+      private
+      def parseHeader
+        raise "recv package size #{@header} != #{@header_len}, cmd: #{@cmd}" unless @header.length == @header_len
+        raise "recv cmd: #{@header[8]} is not correct, expect cmd: #{CMD::RESP_CODE}, cmd: #{@cmd}" unless @header[8] == CMD::RESP_CODE
+        raise "recv erron #{@header[9]} 0 is correct, cmd: #{@cmd}" unless @header[9] == 0
+        {status: true, body_length: @header[0...8].to_pack_long}
+      end
+
+    end
+  end
+end

data/lib/fastdfs-client/storage.rb

@@ -0,0 +1,71 @@
+require 'tempfile'
+
+module Fastdfs
+  module Client
+
+    class Storage
+      extend Hook
+
+      before(:upload, :delete){ @socket.connection }
+      after(:upload, :delete){ @socket.close }
+
+      attr_accessor :host, :port, :group_name, :store_path, :socket, :options
+
+      def initialize(host, port, store_path = nil, options = {})
+        @host = host
+        @port = port
+        @options = options || {}
+        @options = store_path if store_path.is_a?(Hash)
+        @socket = Socket.new(host, port, @options[:socket])
+        @extname_len = ProtoCommon::EXTNAME_LEN
+        @size_len = ProtoCommon::SIZE_LEN        
+        @store_path = store_path || 0
+      end
+
+      def upload(file)  
+        _upload(file)
+      end
+
+      def delete(path, group_name = nil)
+        cmd = CMD::DELETE_FILE
+        raise "path arguments is empty!" if path.blank?
+        if group_name.blank?
+          group_name = /^\/?(\w+)/.match(path)[1]
+          path = path.gsub("/#{group_name}")
+        end
+        raise "group_name arguments is empty!" if group_name.blank?
+        group_bytes = group_name.bytes.fill(0, group_name.length...ProtoCommon::GROUP_NAME_MAX_LEN)
+        path_length = (group_bytes.length + path.bytes.length)
+
+        @socket.write(cmd, (ProtoCommon.header_bytes(cmd, path_length) + group_bytes + path.bytes))
+        @socket.receive
+      end
+
+      private 
+      def _upload(file)
+        cmd = CMD::UPLOAD_FILE
+
+        extname = File.extname(file)[1..-1]
+        ext_name_bs = extname.bytes.fill(0, extname.length...@extname_len)
+        hex_len_bytes = Utils.number_to_Buffer(file.size)
+        size_byte = [@store_path].concat(hex_len_bytes).fill(0, (hex_len_bytes.length+1)...@size_len)
+
+        header = ProtoCommon.header_bytes(cmd, (size_byte.length + @extname_len + file.size))
+        pkg = header + size_byte + ext_name_bs
+
+        @socket.write(cmd, pkg)
+        @socket.write(cmd, IO.read(file))
+        @socket.receive do |body|
+          group_name_max_len = ProtoCommon::GROUP_NAME_MAX_LEN
+          
+          {
+            group_name: body[0...group_name_max_len].strip, 
+            path: body[group_name_max_len..-1]
+          }
+        end
+      end
+      
+    end
+
+  end
+end

data/lib/fastdfs-client/tracker.rb

@@ -0,0 +1,35 @@
+require 'fastdfs-client/storage'
+
+module Fastdfs
+  module Client
+
+    class Tracker
+      extend Hook
+
+      before(:get_storage){ @socket.connection }
+      after(:get_storage){ @socket.close }
+
+      attr_accessor :socket, :cmd, :options
+
+      def initialize(host, port, options = {})
+        @socket = Socket.new(host, port, options[:socket])
+        @cmd = CMD::STORE_WITHOUT_GROUP_ONE
+      end
+
+      def get_storage
+        header = ProtoCommon.header_bytes(@cmd, 0)
+        @socket.write(@cmd, header)
+        @socket.receive do |body|
+          storage_ip = body[ProtoCommon::IPADDR].strip
+          storage_port = body[ProtoCommon::PORT].unpack("C*").to_pack_long
+          store_path = body[ProtoCommon::TRACKER_BODY_LEN-1].unpack("C*")[0]
+          
+          Storage.new(storage_ip, storage_port, store_path, options)
+        end
+
+
+      end
+    end
+
+  end
+end

data/lib/fastdfs-client/utils.rb

@@ -0,0 +1,13 @@
+module Utils
+
+  def self.number_to_Buffer(num)
+    8.times.map{|i| (num >> (56 - 8 * i)) & 255}
+  end
+
+  def self.array_merge(arr1, arr2)
+    raise "argument must be array" unless arr1.is_a?(Array) || arr2.is_a?(Array)
+    arr2.each_with_index.map{|v, i| arr1[i] = v }
+    arr1
+  end
+
+end

data/lib/fastdfs-client/version.rb

@@ -0,0 +1,5 @@
+module Fastdfs
+  module Client
+    VERSION = '0.0.2'
+  end
+end

data/spec/mock_tcp_socket.rb

@@ -0,0 +1,74 @@
+
+class TCPSocket
+  include Fastdfs::Client
+
+  attr_accessor :host, :port, :cmd, :recv_offset, :connect_state
+
+  def initialize(host, port)
+    @host = host
+    @port = port
+    @recv_offset = 0
+    @connect_state = true
+    @cmd = nil
+  end
+
+  def write(*args)
+    pkg = args[0].unpack("C*")
+    @cmd ||= pkg[8] 
+  end
+
+  def recv(len)
+    recv_data = recv_config[@cmd.to_s] || {}
+    data = recv_data.key?(:recv_bytes) ? recv_data[:recv_bytes].call(len) : nil
+    @recv_offset = len
+    data
+  end
+
+  def close
+    @recv_offset = 0
+    @connect_state = false
+    @cmd = nil
+  end
+
+  def closed?
+    @connect_state
+  end
+
+  private 
+
+  def recv_config
+    {
+      "101" => {
+        recv_bytes: lambda do |len|
+          header = ProtoCommon.header_bytes(CMD::RESP_CODE, 0)
+          header[7] = ProtoCommon::TRACKER_BODY_LEN
+
+          group_name = Utils.array_merge([].fill(0, 0...16), TestConfig::GROUP_NAME.bytes)
+          ip = Utils.array_merge([].fill(0, 0...15), TestConfig::STORAGE_IP.bytes)
+          port = Utils.number_to_Buffer(TestConfig::STORAGE_PORT.to_i)
+          store_path = Array(TestConfig::STORE_PATH)
+
+          (header+group_name+ip+port+store_path)[@recv_offset...@recv_offset+len].pack("C*")
+        end
+      },
+      "11" => {
+        recv_bytes: lambda do |len|
+          header = ProtoCommon.header_bytes(CMD::RESP_CODE, 0)
+          group_name = Utils.array_merge([].fill(0, 0...16), TestConfig::GROUP_NAME.bytes)
+          file_name = TestConfig::FILE_NAME.bytes
+          res = (group_name + file_name)
+          header[7] = (header + res).length
+          res = (header + res)
+          
+          res[@recv_offset...@recv_offset+len].pack("C*")
+        end
+      },
+      "12" => {
+        recv_bytes: lambda do |len|
+          header = ProtoCommon.header_bytes(CMD::RESP_CODE, 0)
+          header.pack("C*")
+        end
+      }
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'debugger'
+require 'rspec'
+require 'rspec/core'
+require 'rspec/mocks'
+require File.expand_path('../../lib/fastdfs-client', __FILE__)
+require File.expand_path('../test_config', __FILE__)
+require File.expand_path('../mock_tcp_socket', __FILE__)
+
+FC = Fastdfs::Client
+
+RSpec.configure do |config|
+  config.mock_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+end

data/spec/storage_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Fastdfs::Client::Storage do 
+
+  let(:host){ "192.168.9.16" }
+  let(:port){ "22122" }
+
+  let(:tracker){ FC::Tracker.new(host, port) }
+  let(:storage){ tracker.get_storage }
+
+  it "initialize the server" do 
+    expect(FC::Socket).to receive(:new).with(host, port, nil) 
+    FC::Storage.new(host, port) 
+  end
+
+  it "should have access to the storage connection" do
+    expect(storage.socket).to receive(:connection)
+    expect(storage.socket).to receive(:close)
+    storage.upload(TestConfig::FILE)
+  end
+
+  it "should the result attributes group_name and path" do 
+    res = storage.upload(TestConfig::FILE)
+    expect(res).to include(:group_name)
+    expect(res).to include(:path)
+  end
+
+  it "can delete file by group and path" do 
+    res = storage.upload(TestConfig::FILE)
+    storage.delete(res[:path], res[:group_name])
+  end
+
+  it "can delete file raise exception" do 
+    res = storage.upload(TestConfig::FILE)
+    result = FC::ProtoCommon.header_bytes(FC::CMD::RESP_CODE, 0, 22)
+    TCPSocket.any_instance.stub("recv").and_return(result.pack("C*"))
+    expect{ storage.delete("fdsaf", res[:group_name]) }.to raise_error(RuntimeError)
+  end
+
+end

data/spec/test_config.rb

@@ -0,0 +1,12 @@
+module TestConfig
+  STORAGE_IP = "192.168.8.23"
+  STORAGE_PORT = "23000"
+  STORE_PATH = 0
+  GROUP_NAME = "group1"
+  FILE_NAME = "M00/04/47/wKgIF1cHcQyAeAF7AAACVHeY6n8267.png"
+
+  FILE = Tempfile.new("test.jpg")
+  FILE.write("testtest")
+  FILE.close
+
+end

data/spec/tracker_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Fastdfs::Client::Tracker do 
+
+  let(:host){ "192.168.9.16" }
+  let(:port){ "22122" }
+
+  let(:tracker){ FC::Tracker.new(host, port) }
+
+  it "initialize the server" do 
+    expect(FC::Socket).to receive(:new).with(host, port, nil) 
+    FC::Tracker.new(host, port) 
+  end
+
+  it "should have access to the storage connection" do
+    expect(tracker.socket).to receive(:connection)
+    expect(tracker.socket).to receive(:close)
+    tracker.get_storage
+  end
+
+  it "should have access to the storage class" do 
+    expect(tracker.get_storage.class).to eq(FC::Storage)
+  end
+
+  it "verify the server address and port" do 
+    expect(tracker.get_storage.host).to eq(TestConfig::STORAGE_IP)
+    #[0, 0, 0, 0, 0, 89, 216, 0]
+    expect(tracker.get_storage.port.to_s).to eq(TestConfig::STORAGE_PORT)
+    expect(tracker.get_storage.store_path).to eq(TestConfig::STORE_PATH)
+  end
+
+  it "run server flow" do 
+    # storage = tracker.get_storage
+    # puts "#{storage.host}, #{storage.port}"
+    # results = storage.upload(File.open("/Users/huxinghai/Documents/shark/app/assets/images/page.png"))
+    # puts storage.delete(results[:path], results[:group_name])
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: fastdfs-client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ka Ka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: fastdfs upload file client for ruby
+email:
+- huxinghai1988@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- fastdfs-client.gemspec
+- lib/fastdfs-client.rb
+- lib/fastdfs-client/cmd.rb
+- lib/fastdfs-client/extend_core.rb
+- lib/fastdfs-client/hook.rb
+- lib/fastdfs-client/proto_common.rb
+- lib/fastdfs-client/socket.rb
+- lib/fastdfs-client/storage.rb
+- lib/fastdfs-client/tracker.rb
+- lib/fastdfs-client/utils.rb
+- lib/fastdfs-client/version.rb
+- spec/mock_tcp_socket.rb
+- spec/spec_helper.rb
+- spec/storage_spec.rb
+- spec/test_config.rb
+- spec/tracker_spec.rb
+homepage: https://github.com/huxinghai1988/fastdfs-client-ruby.git
+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: fastdfs upload file client for ruby
+test_files:
+- spec/mock_tcp_socket.rb
+- spec/spec_helper.rb
+- spec/storage_spec.rb
+- spec/test_config.rb
+- spec/tracker_spec.rb
+has_rdoc: