minep-request 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,17 @@
+minep-request
+=============
+
+minep-request is a ruby gem allowing to communicate with a [MINE server](http://github.com/Ezveus/Mine)
+
+  Requests are AUTHENTICATE, SIGNUP, EXEC, INSERT, MOVE, BACKSPACE and DELETE.
+
+Arguments required :
+--------------------
+
+- AUTHENTICATE : *name* and *pass*
+- SIGNUP : *name*, *pass*, *email* and (optionaly) *website*
+- EXEC : Not implemented yet
+- INSERT : Not implemented yet
+- MOVE : Not implemented yet
+- BACKSPACE : Not implemented yet
+- DELETE : Not implemented yet

data/bin/mine-request

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'rubygems'
+require 'minep'
+
+request = nil
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = <<-eos
+Usage: mine-request -r REQUEST [OPTION]... REQUEST_ARGUMENTS
+Send a request to a MINE server
+
+Valid requests are :
+#{MINEP.requestList}
+eos
+
+  opts.on("-r", "--request REQUEST",
+          MINEP.requestList, "request to send") do |r|
+    request = r
+  end
+
+  opts.on "-h", "--host HOST", "server hostname" do |h|
+    options[:host] = h
+  end
+
+  opts.on "-p", "--port PORT", Integer, "server port" do |p|
+    options[:port] = p
+  end
+
+  opts.on "--help", "displays this screen" do |h|
+    puts opts
+    exit 1
+  end
+end
+
+begin
+  optparse.parse!
+  if request.nil?
+    puts "Missing option : request\n"
+    puts optparse
+    exit 1
+  end
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument, OptionParser::InvalidArgument
+  puts $!.to_s
+  puts optparse
+  exit 1
+end  
+
+ARGV.each do |arg|
+  args = arg.split '='
+  options[args[0].to_sym] = args[1]
+end
+begin
+  MINEP.send request, options
+rescue MINEP::ArgumentsError => e
+  $stderr.puts "Error : #{e}"
+  exit 1
+end

data/lib/minep/connection.rb

@@ -1,5 +1,9 @@
 module MINEP
+  # This class extends EM::Connection (the connection class of EventMachine)
   class Connection < EM::Connection
+    # Initialize the object
+    #
+    # @param [Hash] request is the request, The text request is built from this
     def initialize request
       super
       @request = ["#{request[:header][:head]}\n"]
@@ -22,10 +26,12 @@ module MINEP
       @request = @request.join
     end
 
+    # Send the request after the connection initialization
     def post_init
       send_data @request
     end
 
+    # Receive the answer of the server and puts it on standard output
     def receive_data data
       puts data
     end

data/lib/minep/exceptions.rb

@@ -0,0 +1,18 @@
+module MINEP
+  class ArgumentsError < Exception
+  end
+
+  # Raise a ArgumentsError with "Not enough arguments for request" as an argument
+  #
+  # @param [String] rqst the request which called the function
+  def self.notEnoughArgs rqst
+    raise ArgumentsError, "Not enough arguments for request #{rqst}"
+  end
+
+  # Raise a ArgumentsError with "Missing mandatory arguments for request" as an argument
+  #
+  # @param [String] rqst the request which called the function
+  def self.missingArgs rqst
+    raise ArgumentsError, "Missing mandatory arguments for request #{rqst}"
+  end
+end

data/lib/minep/minep.rb

@@ -1,4 +1,9 @@
 module MINEP
+  # Send a request to opts\[:host\] or localhost on port
+  # opts\[:port\] or 8080
+  #
+  # @param [Symbol] type the request type, see main page for the requests list
+  # @param [Hash] opts stores the parameters of the request and host and port, see main page for the requests parameters
   def self.send type, opts={}
     request = {}
     return false unless Utils.makeRequest request, type, opts

data/lib/minep/request.rb

@@ -1,39 +1,108 @@
 module MINEP
+  RequestList = [
+                 :authenticate,
+                 :signup,
+                 :exec,
+                 :insert,
+                 :move,
+                 :backspace,
+                 :delete
+                ]
+
+  # Returns an array containing the request list
+  def self.requestList
+    RequestList
+  end
+
+  # Returns a string containing the request list under the form "\t-> request\n..."
+  def RequestList.to_s
+    "\t-> authenticate\n\t-> signup\n\t-> exec\n\t-> insert\n\t-> move\n\t-> backspace\n\t-> delete\n"
+  end
+
+  # Module containing methods for checking requests arguments
   module Request
+
+    # Checks arguments for authenticate and create the request body
+    #
+    # @param [Hash] request will contain the request (headers and body)
+    # @param [Hash] opts contains the options and arguments get from MINEP.send
+    # @option opts [String] :name The user login/email
+    # @option opts [String] :pass The user password
     def self.authenticate request, opts={}
-      return false if opts.empty?
-      return false if opts[:name].nil? or opts[:pass].nil?
+      MINEP.notEnoughArgs "AUTHENTICATE" if opts.empty?
+      MINEP.missingArgs "AUTHENTICATE" if opts[:name].nil? or opts[:pass].nil?
       Utils.makeAuthenticate request, opts
     end
 
+    # Checks arguments for signup and create the request body
+    # @param [String] website is the url of the website of the new user, passed through opts
+    #
+    # @param [Hash] request will contain the request (headers and body)
+    # @param [Hash] opts contains the options and arguments get from MINEP.send
+    # @option opts [String] :name The login of the new user
+    # @option opts [String] :pass The password of the new user
+    # @option opts [String] :email The email of the new user
     def self.signup request, opts={}
-      return false if opts.empty?
-      return false if opts[:name].nil? or opts[:pass].nil? or opts[:email].nil?
+      MINEP.notEnoughArgs "SIGNUP" if opts.empty?
+      MINEP.missingArgs "SIGNUP" if opts[:name].nil? or opts[:pass].nil? or opts[:email].nil?
+      Utils.makeSignup request, opts
     end
 
+    # Checks arguments for exec and create the request body
+    #
+    # @param [Hash] request will contain the request (headers and body)
+    # @param [Hash] opts contains the options and arguments get from MINEP.send
+    # @option opts [String] :buffer The buffer on which you apply the command
+    # @option opts [String] :command The command to apply
+    # @option opts [Array] :args The (potentially empty) array containing arguments for the command
     def self.exec request, opts={}
-      return false if opts.empty?
-      return false if opts[:buffer].nil? or opts[:command].nil? or opts[:args].nil?
+      MINEP.notEnoughArgs "EXEC" if opts.empty?
+      MINEP.missingArgs "SIGNUP" if opts[:buffer].nil? or opts[:command].nil? or opts[:args].nil?
     end
 
+    # Checks arguments for insert and create the request body
+    #
+    # @param [Hash] request will contain the request (headers and body)
+    # @param [Hash] opts contains the options and arguments get from MINEP.send
+    # @option opts [String] :buffer The buffer on which you insert text
+    # @option opts [String] :text The text to insert
     def self.insert request, opts={}
-      return false if opts.empty?
-      return false if opts[:buffer].nil? or opts[:text].nil?
+      MINEP.notEnoughArgs "INSERT" if opts.empty?
+      MINEP.missingArgs "INSERT" if opts[:buffer].nil? or opts[:text].nil?
     end
 
+    # Checks arguments for move and create the request body
+    #
+    # @param [Hash] request will contain the request (headers and body)
+    # @param [Hash] opts contains the options and arguments get from MINEP.send
+    # @option opts [String] :buffer The buffer on which you move the cursor
+    # @option opts [Symbol] :direction The direction of the move
+    # @option opts [Integer] :number The range of the move (unused on :origin or :end move)
     def self.move request, opts={}
-      return false if opts.empty?
-      return false if opts[:buffer].nil? or opts[:direction].nil? or opts[:number].nil?
+      MINEP.notEnoughArgs "MOVE" if opts.empty?
+      MINEP.missingArgs "MOVE" if opts[:buffer].nil? or opts[:direction].nil? or opts[:number].nil?
     end
 
+    # Checks arguments for backspace and create the request body
+    #
+    # @param [Hash] request will contain the request (headers and body)
+    # @param [Hash] opts contains the options and arguments get from MINEP.send
+    # @option opts [String] :buffer The buffer on which you suppress
+    # @option opts [Integer] :number The range of the suppression
     def self.backspace request, opts={}
-      return false if opts.empty?
-      return false if opts[:buffer].nil? or opts[:number].nil?
+      MINEP.notEnoughArgs "BACKSPACE" if opts.empty?
+      MINEP.missingArgs "BACKSPACE" if opts[:buffer].nil? or opts[:number].nil?
     end
 
+    # Checks arguments for delete and create the request body
+    #
+    # @param [Hash] request will contain the request (headers and body)
+    # @param [Hash] opts contains the options and arguments get from MINEP.send
+    # @option opts [String] :buffer The buffer on which you delete
+    # @option opts [Integer] :number The range of the deletion
     def self.delete request, opts={}
-      return false if opts.empty?
-      return false if opts[:buffer].nil? or opts[:number].nil?
+      MINEP.notEnoughArgs "DELETE" if opts.empty?
+      MINEP.missingArgs "DELETE" if opts[:buffer].nil? or opts[:number].nil?
     end
   end
 end

data/lib/minep/utils.rb

@@ -1,5 +1,6 @@
 module MINEP
   module Utils
+    # Make the request (header + body)
     def self.makeRequest request, type, opts
       Utils.getHeader request, opts[:host], opts[:port]
       case type
@@ -14,7 +15,8 @@ module MINEP
         false
       end
     end
-    
+
+    # Make the request header
     def self.getHeader request, host=nil, port=nil
       host = "localhost" if host.nil?
       port = 8080 if host.nil?
@@ -28,6 +30,7 @@ module MINEP
       true
     end
 
+    # Calculate the body length
     def self.calcLength request
       rqst = request[:body].keys[0]
       cL = rqst.size # rqst
@@ -38,6 +41,7 @@ module MINEP
       cL -= 1   # the loop counts one inexistant ','
     end
 
+    # Make the body for AUTHENTICATE request
     def self.makeAuthenticate request, options
       request[:body] = {
         :authenticate => {
@@ -48,5 +52,19 @@ module MINEP
       request[:header][:contentLength] = calcLength request
       true
     end
+
+    # Make the body for SIGNUP request
+    def self.makeSignup request, options
+      request[:body] = {
+        :signup => {
+          :name => options[:name],
+          :pass => options[:pass],
+          :email => options[:email],
+          :website => options[:website].to_s
+        }
+      }
+      request[:header][:contentLength] = calcLength request
+      true
+    end
   end
 end

data/lib/minep.rb

@@ -3,7 +3,6 @@ require 'eventmachine'
 require 'json'
 
 # Requiring internal files
-require 'minep/minep'
-require 'minep/request'
-require 'minep/utils'
-require 'minep/connection'
+%w[minep request utils connection exceptions].each do |file|
+  require "minep/#{file}"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minep-request
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,20 +9,29 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-09 00:00:00.000000000 Z
+date: 2012-11-13 00:00:00.000000000 Z
 dependencies: []
-description: Allows to communicate with a MINE server
+description: ! 'Allows to communicate with a MINE server.
+
+  Supported requests are the same as the implemented requests in the server : AUTHENTICATE
+  and SIGNUP.
+
+'
 email: ciappam@gmail.com
-executables: []
+executables:
+- mine-request
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/minep.rb
 - lib/minep-request.rb
 - lib/minep/connection.rb
+- lib/minep/exceptions.rb
 - lib/minep/minep.rb
 - lib/minep/request.rb
 - lib/minep/utils.rb
+- README.md
+- bin/mine-request
 homepage: https://github.com/Ezveus/minep-request
 licenses: []
 post_install_message: 
@@ -48,3 +57,4 @@ signing_key:
 specification_version: 3
 summary: Allows to communicate with a MINE server
 test_files: []
+has_rdoc: