ramp 0.1.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.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 ramp.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sameer Rahmani
+
+MIT License
+
+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,29 @@
+# Ramp
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ramp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ramp
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/ramp/command.rb

@@ -0,0 +1,192 @@
+# -----------------------------------------------------------------------------
+#    RAMP - AMP protocol client implementation in Ruby
+#    Copyright (C) 2012 Yellowen
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with this program; if not, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# -----------------------------------------------------------------------------
+
+module Ramp
+
+  class Command
+
+    # EignClass -------------------------------------
+    class << self
+      
+      attr_accessor :arguments_hash, :responses_hash, :command_name
+
+      def arguments args
+        @arguments_hash = args
+      end
+
+      def responses args
+        @responses_hash = args
+      end
+
+      def command name
+        @command_name = name
+      end
+
+      def loads(data)
+        # Construct a hash from given data and return it
+        buffer = data.to_s.bytes.to_a
+        pos = 0
+        result = {}
+
+        while 1 do
+
+          # Parse the next key length
+          key_length = 0
+          buffer[pos..pos + 1].each {|x| key_length += x}
+
+          if key_length > 255
+            raise TypeError, "malform packet."
+          end
+
+          if key_length == 0
+            # key length of 0 means end of package.
+            break
+          end
+
+          pos += 2
+          # Read the key 
+          key = buffer[pos..pos + key_length - 1].pack("c*")
+        
+          # Parse next value length
+          pos += key_length
+          value_length = 0
+          buffer[pos..pos + 1].each {|x| value_length += x}
+
+          # Read the value
+          pos += 2
+          value = buffer[pos..pos + value_length - 1].pack("c*")
+          pos += value_length
+          result[key.to_sym] = value
+
+        end
+      
+        result
+      end
+    end
+
+    # Public -------------------------------------
+
+    # A Class variable (static attribute) to hold the asks sequences
+    @@ask_seqs = []
+
+    attr_reader :values
+
+    def initialize (args)
+      # Initialize an object with provided values for fields defined in
+      # @arguments using argument class method
+      @values = {}
+      @buffer = []
+      
+      @_args = args
+
+      kwargs = Hash[args.map{|k, v|[k.to_sym, v]}]
+      if kwargs.include? :_ask or kwargs.include? :_command
+        raise ArgumentError, "':_ask' and ':_command' should not be in arguments"
+      end
+
+      kwargs.each do |key, value|
+
+        # Check for key validation
+        if not self.class.arguments_hash.include? key
+          raise ArgumentError, "'#{key}' is not defined in '#{self.class}'."
+        end
+
+
+        # Construct the values ivar
+        @values[key.to_sym] = self.class.arguments_hash[key.to_sym].new value
+      end
+
+      # Build a AMP packet data from kwargs hash for more information about
+      # amp protocol structure take a look at:
+      # http://www.amp-protocol.net
+ 
+      @values[:_command] = self.class.command_name
+
+      while 1 do
+        # TODO: is it safe in logic ?
+        ask = rand(999999)
+        if not @@ask_seqs.include? ask
+          @@ask_seqs << ask
+          break
+        end
+      end
+      
+      @values[:_ask] = ask
+      # Generate the packet data and store it into @buffer
+      generate_packet
+       
+    end
+
+
+    def to_s
+     
+      @buffer.pack("c*")      
+    end
+
+    def to_a
+      @buffer
+    end
+
+    def ask
+      @values[:_ask]
+    end
+
+    def dup
+      self.class.new @_args
+    end
+
+    def callback (*)
+      # Each subclass may override this method to have a callback
+      # when any answer recieved.
+      nil
+    end
+
+    # Exceptions ------------------------------------------------
+    class KeyLenError < StandardError
+    end
+
+    private
+    # Private definations ---------------------------------------
+    def split_bytes (hex)
+      hex.each_char.each_slice(2).map {|x| x.join}
+    end
+
+    def generate_packet()
+      @values.each do |key, value|
+
+        if key.length > 255
+          raise KeyLenError, "AMP keys should have 255 byte max kength"
+        end
+        
+        [0, key.to_s.bytes.to_a.length].each {|x| @buffer << x}
+        key.to_s.bytes.to_a.each {|x| @buffer << x}
+
+        value_lenght = split_bytes "%04x" % value.to_s.bytes.to_a.length.to_s(16)
+        @buffer << value_lenght[0].to_i
+        @buffer << value_lenght[1].to_i
+        
+        
+        value.to_s.bytes.to_a.each {|x| @buffer << x}
+      end
+
+      [0x00, 0x00].each {|x| @buffer << x}
+    end 
+
+  end
+end

data/lib/ramp/fields.rb

@@ -0,0 +1,54 @@
+# -----------------------------------------------------------------------------
+#    RAMP - AMP protocol client implementation in Ruby
+#    Copyright (C) 2012 Yellowen
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with this program; if not, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# -----------------------------------------------------------------------------
+
+module Ramp
+  module Fields
+
+    class StringField < String
+
+      def self.to_o data
+        String.new data
+      end
+
+    end
+
+    class IntegerField < Integer
+    
+      def self.to_o data
+        Integer.new data
+      end
+
+    end
+
+    class JsonField < Hash
+      
+      require 'json'
+
+      def to_s
+        JSON.dump(self)
+      end
+
+      def self.to_o data
+        JSON.load(data)
+      end
+
+    end
+
+  end
+end

data/lib/ramp/version.rb

@@ -0,0 +1,3 @@
+module Ramp
+  VERSION = "0.1.1"
+end

data/lib/ramp.rb

@@ -0,0 +1,120 @@
+# -----------------------------------------------------------------------------
+#    RAMP - AMP protocol client implementation in Ruby
+#    Copyright (C) 2012 Yellowen
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with this program; if not, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# -----------------------------------------------------------------------------
+require 'socket'
+
+require "ramp/version"
+require "ramp/command.rb"
+require "ramp/fields.rb"
+
+
+module Ramp
+  # Ramp module
+
+  class AmpClient
+    # AmpClient class is responsble for establishing a connection to a AMPserver
+
+    @@sent_packets = Hash.new
+
+    def initialize (host, port, kwargs={secure: false,
+                      ssl_key: nil,
+                      ssl_cert:nil,
+                      async: false})
+
+      @async = kwargs[:async]
+      @secure = kwargs[:secure]
+      @ssl_key = kwargs[:ssl_key]
+      @ssl_cert = kwargs[:ssl_cert]
+
+      @host = host
+      @port = port
+
+      make_connection
+      
+    end
+
+    def call_remote(command, kwargs)
+
+      # Create a new command instance
+      obj = command.new kwargs
+
+      # Add the curretn command instance to the sent hash
+      @@sent_packets[obj.ask] = obj
+
+      if @async
+        t = Thread.new {
+          transfer obj.to_s
+        }
+        t.abort_on_exception = true
+        t.run
+      else
+        transfer obj.to_s
+      end
+
+    end
+
+    # Private members -----------------------------------
+    private
+    
+    def make_connection 
+
+      begin
+        socket = TCPSocket.new @host, @port
+      rescue Errno::ECONNREFUSED
+        abort("Connection Refused")        
+      end
+
+      if @secure
+        ctx = OpenSSL::SSL::SSLContext.new()
+        ctx.cert = OpenSSL::X509::Certificate.new(File.open(@ssl_cert))
+        ctx.key = OpenSSL::PKey::RSA.new(File.open(@ssl_key))
+        ctx.ssl_version = :SSLv23
+        ssl_socket = OpenSSL::SSL::SSLSocket.new(socket, ctx)
+        ssl_socket.sync_close = true
+        ssl_socket.connect
+        @socket = ssl_socket
+        return 
+
+      end
+
+      @socket = socket
+
+    end
+
+    def transfer data
+      # send the encoded data across the net
+      @socket.syswrite(data)
+      # TODO: Should i specify a recieving limitation ?
+      rawdata = @socket.recv(1024)
+      data = Command::loads(rawdata)
+
+      if data.include? :_answer
+        if @@sent_packets.keys.include? data
+          @@sent_packets[data[:_answer]].callback(data)
+        end
+      elsif data.include? :_error
+        # Generate an exception from _error_code and rise it
+        exception = Object.const_set(data[:_error_code], Class.new(StandardError))
+        raise exception, data[:_error_description]
+      end
+            
+    end
+
+  end
+
+end

data/ramp.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ramp/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Sameer Rahmani"]
+  gem.email         = ["lxsameer@gnu.org"]
+  gem.description   = %q{AMP protocol implementation in Ruby. For more information about AMP protocol take a look at http://amp-protocol.net/}
+  gem.summary       = %q{AMP protocol implementation in Ruby}
+  gem.homepage      = "http://ramp.yellowen.com/"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ramp"
+  gem.require_paths = ["lib"]
+  gem.version       = Ramp::VERSION
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: ramp
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Sameer Rahmani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-08 00:00:00.000000000 Z
+dependencies: []
+description: AMP protocol implementation in Ruby. For more information about AMP protocol
+  take a look at http://amp-protocol.net/
+email:
+- lxsameer@gnu.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ramp.rb
+- lib/ramp/command.rb
+- lib/ramp/fields.rb
+- lib/ramp/version.rb
+- ramp.gemspec
+homepage: http://ramp.yellowen.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: AMP protocol implementation in Ruby
+test_files: []