ramp 0.1.1 → 0.2.1

data/LICENSE

@@ -1,22 +1,339 @@
-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.
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/lib/ramp.rb

@@ -1,6 +1,61 @@
-# -----------------------------------------------------------------------------
+#:title: Ramp Documentation
+#= Ramp
+#Ramp is AMP protocol implementation in Ruby language. AMP is a very
+#simple message passing and RPC protocol. for more information take a
+#look at {here}[http://amp-protocol.net].
+#
+#== Installation
+#As you may know already installing ruby gems it quite easy:
+# $ gem install ramp
+#Isn't it easy ?
+#
+#== Usage
+#As every thing else about Ramp, its usage is easy too :P
+#At first you should be familiar with {AMP protocol}[http://amp-protocol.net]
+#a little, AMP protocol usa <b>Commands</b> as its RPC units and you should
+#define your own <b>Command</b> subclass. Let see an example:
+#
+# require 'ramp'
+#
+# class Event < Ramp::Command
+#
+#   command "Events"
+#
+#   arguments (
+#              {name: Ramp::Fields::StringField,
+#               sender: Ramp::Fields::StringField,
+#               kwargs: Ramp::Fields::JsonField}
+#              )
+#
+#   responses (
+#              {status: Ramp::Fields::IntegerField}
+#              )
+#
+# end
+#
+#Ok, let's talk a bit more about the example class. As your can see the 
+#<i>Event</i> class is a subclass of <b>Ramp::Command</b> class. and we 
+#specify a command for our class by using <b>command</b> class method.
+#Also you should specify the command arguments and responses like above.
+#
+#That is all we need, now we can run the remote command easily like:
+#
+# requre 'ramp'
+# 
+# rempte = Ramp::AmpClient.new 'localhost', 8888, :async => false
+# remote.call_remote(Event, sender: "me", name: "something", kwargs: {:foo => "bar"})
+#
+#That's all. for more information about take a look at _Ramp::AMPClient class.
+#
+#Note:: Remember that Commands should have the same signature as they have on remote server.
+#
+#== Credit
+#Author::    Dave Thomas  (mailto:lxsameer@gnu.org)
+#Copyright:: Copyright (c) 2012 Yellowen Inc
+#License::   Distributes under the term of GPLv3
+
+#--
 #    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
@@ -15,22 +70,30 @@
 #    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"
 
-
+# This module contains all the AMP protocol related classes
 module Ramp
-  # Ramp module
 
+  # AmpClient class is responsble for establishing a connection to a AMP server
   class AmpClient
-    # AmpClient class is responsble for establishing a connection to a AMPserver
 
     @@sent_packets = Hash.new
 
+    # host:: address of remote amp server
+    # port:: port to connect to.
+    # kwarrgs:: is a hash that contains extra optional arguments.
+    # * secure:: Use an SSL secured connection
+    # * ssl_key:: Path to SSL key.
+    # * ssl_cert:: Path to client SSL cert file.
+    # * async:: If this argument was true then Ramp use a threaded solution to
+    #           send the request and handle the response
     def initialize (host, port, kwargs={secure: false,
                       ssl_key: nil,
                       ssl_cert:nil,
@@ -48,7 +111,11 @@ module Ramp
       
     end
 
-    def call_remote(command, kwargs)
+    # This method will call the given command on the remote server with given
+    # arguments in kwargs
+    # command:: is a subclass of *Command* class.
+    # kwargs:: the arguments for the *command*'s initilize method.
+    def call(command, kwargs)
 
       # Create a new command instance
       obj = command.new kwargs

data/lib/ramp/command.rb

@@ -1,3 +1,4 @@
+#--
 # -----------------------------------------------------------------------------
 #    RAMP - AMP protocol client implementation in Ruby
 #    Copyright (C) 2012 Yellowen
@@ -16,9 +17,13 @@
 #    with this program; if not, write to the Free Software Foundation, Inc.,
 #    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 # -----------------------------------------------------------------------------
+# ++
 
 module Ramp
 
+  #Base class for an AMP protocol command. Any user command should subclassed
+  #from this class and define a command name, arguments, reponses and any
+  #exceptions or callback method if needed.
   class Command
 
     # EignClass -------------------------------------
@@ -26,20 +31,33 @@ module Ramp
       
       attr_accessor :arguments_hash, :responses_hash, :command_name
 
+      # Define the command name. Remote server will recognize this command this 
+      # this name.
+      # name:: Command name
+      def command name
+        @command_name = name
+      end
+
+      # Defines all the arguments of the command. arguments should define
+      # in a hash and each one value should be a class that have both 
+      # *to_s* instance method and *to_o* class method.
+      # args:: is the hash that contains the arguments defination
       def arguments args
         @arguments_hash = args
       end
 
+      # Defines all the possible responses of the command. Responses should
+      # define in a hash and each one value should be a class that have both 
+      # *to_s* instance method and *to_o* class method.
+      # args:: is the hash that contains the reponses defination      
       def responses args
         @responses_hash = args
       end
 
-      def command name
-        @command_name = name
-      end
-
+      # Construct a hash from given data and return it. data should be a packed
+      # amp packet.
       def loads(data)
-        # Construct a hash from given data and return it
+
         buffer = data.to_s.bytes.to_a
         pos = 0
         result = {}
@@ -86,7 +104,9 @@ module Ramp
     @@ask_seqs = []
 
     attr_reader :values
-
+    
+    # Inizilize a new command using the *args* parameter, The *args* parameter
+    # should conatain the exact keys as the hash that specify in *arguments*
     def initialize (args)
       # Initialize an object with provided values for fields defined in
       # @arguments using argument class method
@@ -143,21 +163,24 @@ module Ramp
       @buffer
     end
 
+    # Return the current command *_ask* value
     def ask
       @values[:_ask]
     end
 
+    # Duplicat the current command with new *_ask* value
     def dup
       self.class.new @_args
     end
 
+    # Each subclass may override this method to have a callback
+    # when any answer recieved.
     def callback (*)
-      # Each subclass may override this method to have a callback
-      # when any answer recieved.
       nil
     end
 
     # Exceptions ------------------------------------------------
+
     class KeyLenError < StandardError
     end
 

data/lib/ramp/fields.rb

@@ -1,3 +1,4 @@
+#--
 # -----------------------------------------------------------------------------
 #    RAMP - AMP protocol client implementation in Ruby
 #    Copyright (C) 2012 Yellowen
@@ -16,10 +17,14 @@
 #    with this program; if not, write to the Free Software Foundation, Inc.,
 #    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 # -----------------------------------------------------------------------------
+# ++
 
 module Ramp
+
+  # This module contains several Data type class of amp protocol
   module Fields
 
+    # StringField is a simple String class
     class StringField < String
 
       def self.to_o data
@@ -28,6 +33,7 @@ module Ramp
 
     end
 
+    # IntegerField is a simple Integer subclass.
     class IntegerField < Integer
     
       def self.to_o data
@@ -36,6 +42,7 @@ module Ramp
 
     end
 
+    # JsonField is a hash like object and allow your to pass any hash via amp
     class JsonField < Hash
       
       require 'json'

data/lib/ramp/version.rb

@@ -1,3 +1,24 @@
+#--
+# -----------------------------------------------------------------------------
+#    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
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/ramp.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/ramp/version', __FILE__)
+require 'rake'
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Sameer Rahmani"]
@@ -7,11 +8,16 @@ Gem::Specification.new do |gem|
   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.license	    = 'GPL-2'
 
-  gem.files         = `git ls-files`.split($\)
+  gem.has_rdoc	    = true
+  gem.rdoc_options << '--main' << 'lib/ramp.rb' << '--exclude' << 'Rakefile' << '--exclude' << 'Gemfile'
+
+  gem.files         = FileList['lib/**/*.rb', '.gitignore', 'ramp.gemspec', 'LICENSE', 'Gemfile', 'Rakefile'].to_a
   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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ramp
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-08 00:00:00.000000000 Z
+date: 2012-11-09 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/
@@ -19,20 +19,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/ramp/version.rb
+- lib/ramp/fields.rb
+- lib/ramp/command.rb
+- lib/ramp.rb
 - .gitignore
-- Gemfile
+- ramp.gemspec
 - LICENSE
-- README.md
+- Gemfile
 - Rakefile
-- lib/ramp.rb
-- lib/ramp/command.rb
-- lib/ramp/fields.rb
-- lib/ramp/version.rb
-- ramp.gemspec
 homepage: http://ramp.yellowen.com/
-licenses: []
+licenses:
+- GPL-2
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --main
+- lib/ramp.rb
+- --exclude
+- Rakefile
+- --exclude
+- Gemfile
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -49,8 +55,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: AMP protocol implementation in Ruby
 test_files: []
+has_rdoc: true

data/README.md

@@ -1,29 +0,0 @@
-# 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