leo_manager_client 0.4.7

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,178 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+

data/README.md

@@ -0,0 +1,24 @@
+# leo_manager_client
+
+The library of LeoFS-Manager's client for Ruby
+
+## Installation
+    
+    $ gem install leo_manager_client
+
+## Usage
+
+```ruby
+require "leo_manager_client"
+
+manager = LeoManager::Client.new("localhost:10020")
+manager.status #=> #<LeoManager::Status:0x00000001578310 @system_info=#<LeoManager::Status::SystemInfo:0x000000015782e8 @version="0.10.1", @n="1", @r="1", @w="1", @d="1", @ring_size="128", @ring_cur=nil, @ring_prev=nil>, @node_list=[#<LeoManager::Status::NodeInfo:0x00000001578298 @type="S", @node="storage_0@127.0.0.1", @state="running", @ring_cur="a039acc0", @ring_prev="a039acc0", @joined_at="2012-09-21 15:08:22 +0900">, #<LeoManager::Status::NodeInfo:0x00000001578248 @type="G", @node="gateway_0@127.0.0.1", @state="running", @ring_cur="a039acc0", @ring_prev="a039acc0", @joined_at="2012-09-21 15:08:25 +0900">]>
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,33 @@
+# ======================================================================
+#
+#  LeoFS Manager Client
+#
+#  Copyright (c) 2012-2013 Rakuten, Inc.
+#
+#  This file is provided to you under the Apache License,
+#  Version 2.0 (the "License"); you may not use this file
+#  except in compliance with the License.  You may obtain
+#  a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+#
+# ======================================================================
+require 'rubygems'
+require 'rake'
+require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "-c -f d --tty"
+end

data/leo_manager_client.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "leo_manager_client"
+
+Gem::Specification.new do |gem|
+  gem.name          = "leo_manager_client"
+  gem.version       = LeoManager::VERSION
+  gem.authors       = ["Yosuke Hara"]
+  gem.email         = ["leofaststorage@gmail.com"]
+  gem.description   = %q{Client for LeoFS-Manager}
+  gem.summary       = %q{Client for LeoFS-Manager}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/leo_manager_client.rb

@@ -0,0 +1,418 @@
+# ======================================================================
+#
+#  LeoFS Manager Client
+#
+#  Copyright (c) 2012 Rakuten, Inc.
+#
+#  This file is provided to you under the Apache License,
+#  Version 2.0 (the "License"); you may not use this file
+#  except in compliance with the License.  You may obtain
+#  a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+#
+# ======================================================================
+require "socket"
+require "json"
+require "time"
+
+require_relative "leo_manager_models"
+
+module LeoManager
+  VERSION = "0.4.7"
+
+  class Client
+    CMD_VERSION           = "version"
+    CMD_LOGIN             = "login %s %s"
+    CMD_STATUS            = "status %s"
+    CMD_START             = "start"
+    CMD_DETACH            = "detach %s"
+    CMD_SUSPEND           = "suspend %s"
+    CMD_RESUME            = "resume %s"
+    CMD_REBALANCE         = "rebalance"
+    CMD_WHEREIS           = "whereis %s"
+    CMD_DU                = "du %s"
+    CMD_COMPACT_START     = "compact start %s %s %s"
+    CMD_COMPACT_START_ALL = "compact start %s all"
+    CMD_COMPACT_SUSPEND   = "compact suspend %s"
+    CMD_COMPACT_RESUME    = "compact resume %s"
+    CMD_COMPACT_STATUS    = "compact status %s"
+    CMD_PURGE             = "purge %s"
+    CMD_CRE_USER          = "create-user %s %s"
+    CMD_UPD_USER_ROLE     = "update-user-role %s %s"
+    CMD_UPD_USER_PASS     = "update-user-password %s %s"
+    CMD_DEL_USER          = "delete-user %s"
+    CMD_GET_USERS         = "get-users"
+    CMD_SET_ENDPOINT      = "set-endpoint %s"
+    CMD_DEL_ENDPOINT      = "delete-endpoint %s"
+    CMD_GET_ENDPOINTS     = "get-endpoints"
+    CMD_ADD_BUCKET        = "add-bucket %s %s"
+    CMD_DELETE_BUCKET     = "delete-bucket %s %s"
+    CMD_GET_BUCKETS       = "get-buckets"
+    CMD_RECOVER_FILE      = "recover file %s"
+    CMD_RECOVER_NODE      = "recover node %s"
+    CMD_RECOVER_RING      = "recover ring %s"
+
+    USER_ROLES = RoleDef.invert
+
+    # ======================================================================
+    # APIs
+    # ======================================================================
+    # Constructor
+    #
+    def initialize(*servers)
+      @servers = parse_servers(servers)
+      set_current_server
+      @mutex = Mutex.new
+      connect
+    end
+
+    # servers to connect
+    attr_reader :servers
+    # the server currently connected
+    attr_reader :current_server
+
+    # Retrieve LeoFS's version from LeoFS Manager
+    # Return::
+    #   Version of LeoFS
+    def version
+      h = sender(CMD_VERSION)
+      return h[:result]
+    end
+
+    # Retrieve LeoFS's system status from LeoFS Manager
+    # Return::
+    #   Status
+    def status(node=nil)
+      Status.new(sender(CMD_STATUS % node))
+    end
+
+    # Login as specifies user
+    # Return::
+    #   LoginInfo
+    def login(user_id, password)
+      LoginInfo.new(sender(CMD_LOGIN % [user_id, password]))
+    end
+
+    # Launch LeoFS's storage cluster
+    # Return::
+    #   _nil_
+    def start
+      sender(CMD_START)
+      nil
+    end
+
+    # Leave a node from the storage cluster
+    # Return::
+    #   _nil_
+    def detach(node)
+      sender(CMD_DETACH % node)
+      nil
+    end
+
+    # Suspend a node in the storage cluster
+    # Return::
+    #   _nil_
+    def suspend(node)
+      sender(CMD_SUSPEND % node)
+      nil
+    end
+
+    # Resume a node in the storage cluster
+    # Return::
+    #   _nil_
+    def resume(node)
+      sender(CMD_RESUME % node)
+      nil
+    end
+
+    # Execute 'rebalance' in the storage cluster
+    # Return::
+    #   _nil_
+    def rebalance
+      sender(CMD_REBALANCE)
+      nil
+    end
+
+    # Retrieve assigned file information
+    # Return::
+    #   Array of AssignedFile
+    def whereis(path)
+      assigned_info = sender(CMD_WHEREIS % path)[:assigned_info]
+      assigned_info.map {|h| AssignedFile.new(h)}
+    end
+
+    # Retrieve storage status from the storage
+    # Return::
+    #   StorageStat
+    def du(node)
+      StorageStat.new(sender(CMD_DU % node))
+    end
+
+    # Execute 'compact start'
+    # Return::
+    #   _nil_
+    def compact_start(node, num_of_targets_or_all, num_of_concurrents=nil)
+      case num_of_targets_or_all.to_s
+      when /^all$/i
+        sender(CMD_COMPACT_START_ALL % node)
+      else
+        num_of_concurrents = num_of_concurrents ? Integer(num_of_concurrents) : ""
+        sender(CMD_COMPACT_START % [node, Integer(num_of_targets_or_all), num_of_concurrents])
+      end
+      nil
+    end
+
+    # Execute 'compact suspend'
+    # Return::
+    #   _nil_
+    def compact_suspend(node)
+      sender(CMD_COMPACT_SUSPEND % node)
+      nil
+    end
+
+    # Execute 'compact suspend'
+    # Return::
+    #   _nil_
+    def compact_resume(node)
+      sender(CMD_COMPACT_RESUME % node)
+      nil
+    end
+
+    # Execute 'compact status'
+    # Return::
+    #   _nil_
+    def compact_status(node)
+      compaction = sender(CMD_COMPACT_STATUS % node)[:compaction_status]
+      CompactionStatus.new(compaction)
+    end
+
+    # Purge a cache in gateways
+    # Return::
+    #   _nil_
+    def purge(path)
+      sender(CMD_PURGE % path)
+      nil
+    end
+
+    # Generate credential for LeoFS
+    # Return::
+    #   Credential
+    def create_user(user_id, password=nil)
+      Credential.new(sender(CMD_CRE_USER % [user_id, password]))
+    end
+
+    # Update user role
+    # Return ::
+    #   _nil_
+    def update_user_role(user_id, role)
+      role = role.to_sym if role.is_a? String
+      role = USER_ROLES[role] if role.is_a? Symbol
+      sender(CMD_UPD_USER_ROLE % [user_id, role])
+      nil
+    end
+
+    # Update user password
+    # Return::
+    #   _nil_
+    def update_user_password(user_id, new_password)
+      sender(CMD_UPD_USER_PASS % [user_id, new_password])
+      nil
+    end
+
+    # Delete user
+    # Return::
+    #   _nil_
+    def delete_user(user_id)
+      sender(CMD_DEL_USER % user_id)
+      nil
+    end
+
+    def get_users
+      users = sender(CMD_GET_USERS)[:users]
+      users.map {|account| User.new(account) }
+    end
+
+    # Insert an endpoint in the system
+    # Return::
+    #   _nil_
+    def set_endpoint(endpoint)
+      sender(CMD_SET_ENDPOINT % endpoint)
+      nil
+    end
+
+    # Remove an endpoint from the system
+    # Return::
+    #   _nil_
+    def delete_endpoint(endpoint)
+      sender(CMD_DEL_ENDPOINT % endpoint)
+      nil
+    end
+    alias :del_endpoint :delete_endpoint
+
+    # Retrieve an endpoint in the system
+    # Return::
+    #   Array of Endpoint
+    def get_endpoints
+      endpoints = sender(CMD_GET_ENDPOINTS)[:endpoints]
+      endpoints.map {|endpoint| Endpoint.new(endpoint) }
+    end
+
+    # Add an Bucket in the system
+    # Return::
+    #   _nil_
+    def add_bucket(bucket_name, access_key_id)
+      sender(CMD_ADD_BUCKET % [bucket_name, access_key_id])
+      nil
+    end
+
+    # Delete an Bucket in the system
+    # Return::
+    #   _nil_
+    def delete_bucket(bucket_name, access_key_id)
+      sender(CMD_DELETE_BUCKET % [bucket_name, access_key_id])
+      nil
+    end
+
+    # Retrieve all buckets from the system
+    # Return::
+    #   Array of Bucket
+    def get_buckets
+      buckets = sender(CMD_GET_BUCKETS)[:buckets]
+      buckets.map {|bucket| Bucket.new(bucket) }
+    end
+
+    # Recover file
+    # Return::
+    #   nil
+    def recover_file(path)
+      sender(CMD_RECOVER_FILE % path)
+      nil
+    end
+
+    # Recover node
+    # Return::
+    #   nil
+    def recover_node(node)
+      sender(CMD_RECOVER_NODE % node)
+      nil
+    end
+
+    # Recover ring
+    # Return::
+    #   nil
+    def recover_ring(node)
+      sender(CMD_RECOVER_RING % node)
+      nil
+    end
+
+    # Disconnect to LeoFS Manager explicitly
+    # Return::
+    #   _nil_
+    def disconnect!
+      disconnect
+    end
+
+    ## ======================================================================
+    ## PRIVATE
+    ## ======================================================================
+    private
+
+    def parse_servers(servers)
+      servers.map do |server|
+        if server.is_a? String
+          m = server.match(/(?<host>.+):(?<port>[0-9]{1,5})/)
+          host = m[:host]
+          port = Integer(m[:port])
+
+          raise "Invalid Port Number: #{port}" unless 0 <= port && port <= 65535
+          { :host => host, :port => port, :retry_count => 0 }
+        else
+          server
+        end
+      end
+    end
+
+    def set_current_server
+      @servers.delete(@current_server) if @current_server
+      raise "No servers to connect" if @servers.empty?
+      @current_server = @servers.first
+    end
+
+    # Connect to LeoFS Manager
+    def connect
+      retry_count = 0
+      begin
+        @socket = TCPSocket.new(@current_server[:host], @current_server[:port])
+      rescue => ex
+        warn "Faild to connect: #{ex.class} (server: #{@current_server})"
+        warn ex.message
+        retry_count += 1
+        if retry_count > 3
+          set_current_server
+          warn "Connecting another server: #{@current_server}"
+          retry_count = 0
+        end
+        sleep 1
+        retry
+      end
+      @socket.autoclose = true
+      nil
+    end
+
+    def disconnect
+      @socket.close if @socket && !@socket.closed?
+    end
+
+    def reconnect
+      disconnect
+      sleep 1
+      connect
+    end
+
+    # Send a request to LeoFS Manager
+    # Return::
+    #   Hash
+    def sender(command)
+      response = nil
+      begin
+        @mutex.synchronize do
+          @socket.print "#{command}\r\n"
+          line = @socket.readline
+          warn line if $DEBUG
+          response = JSON.parse(line, symbolize_names: true)
+        end
+      rescue EOFError => ex
+        warn "EOFError occured (server: #{@current_server})"
+        reconnect
+      rescue => ex
+        raise "An Error occured: #{ex.class} (server: #{@current_server})\n#{ex.message}"
+      else
+        raise response[:error] if response.has_key?(:error)
+        return response
+      end
+    end
+  end
+end
+
+# This section runs only when the file executed directly.
+if __FILE__ == $PROGRAM_NAME
+  require "pp"
+
+  $DEBUG = true
+  m = LeoManager::Client.new("localhost:10020", "localhost:10021")
+  p m.version
+  p m.status
+  p m.status("storage_0@127.0.0.1")
+  p m.get_buckets()
+  p m.whereis("photo/hawaii-0.jpg")
+  p m.du("storage_0@127.0.0.1")
+  p m.compact_status("storage_0@127.0.0.1")
+end